Inventory Report System Configuration

Retrieve the current configuration

GET /api/v1/system/inventory_report/

Get the current system level configuration for the Inventory Report feature.

Authorization Right: Minimum System Admin.

Example request:

GET /api/v1/system/inventory_report/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "defaultFromAddress": "resourceInventory@example.com"
}
Response JSON Object:

  • defaultFromAddress (string) – The default domain From Address for the Inventory Reports emails.

Status Codes:

Update the configuration

PUT /api/v1/system/inventory_report/

Update the system level configuration for the Inventory Report feature.

Authorization Right: Minimum System Admin.

Example request:

PUT /api/v1/system/inventory_report/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "defaultFromAddress": "yourResourceInventory@example.com"
}
Request JSON Object:

  • defaultFromAddress (string) – (Optional) The default domain From Address for the Inventory Reports emails. Please note that once set, it is not possible an empty value anymore.

Example response:

HTTP/1.1 200 Created
Content-Type: "application/json"

{
   "defaultFromAddress": "yourResourceInventory@example.com"
}
Response JSON Object:

  • defaultFromAddress (string) – The default domain From Address for the Inventory Reports emails.

Status Codes: