Get Tenant Info

Cortex Xpanse REST API

post /public_api/v1/system/get_tenant_info/

Get your tenant license information.
Required license: Cortex Xpanse Expander

Request headers
authorization
String
required
api-key
Example: {{api_key}}
x-xdr-auth-id
String
required
api-key-id
Example: {{api_key_id}}
CURL
curl -X 'POST'
-H 'Accept: application/json'
-H 'authorization: {{api_key}}' -H 'x-xdr-auth-id: {{api_key_id}}'
'https://api-}/public_api/v1/system/get_tenant_info/'
Responses

OK

Body
replyObjectrequired

List of available licenses, number of devices, and purchased add-ons on your tenant.

aumInteger
expiration_dateString
activation_dateString
statusString
RESPONSE
{ "reply": { "aum": 0, "expiration_date": "expiration_date_example", "activation_date": "activation_date_example", "status": "status_example" } }

Bad Request. Got an invalid JSON.

Body
replyObject

The query results upon error.

RESPONSE
{ "reply": {} }

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body
replyObject

The query results upon error.

RESPONSE
{ "reply": {} }

Unauthorized access. User does not have the required license type to run this API.

Body
replyObject

The query results upon error.

RESPONSE
{ "reply": {} }

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body
replyObject

The query results upon error.

RESPONSE
{ "reply": {} }

Unprocessable Entity

Body
codeInteger

Error code

statusString

Error name

messageString

Error message

errorsObject

Errors

RESPONSE
{ "code": 0, "status": "status_example", "message": "message_example", "errors": {} }

Internal server error. A unified status for API communication type errors.

Body
replyObject

The query results upon error.

RESPONSE
{ "reply": {} }