Get Tenant Info

Synopsis

URI
/public_api/v1/system/get_tenant_info/
HTTP Method
GET
Required License
Cortex XDR Prevent, Cortex XDR Pro per Endpoint, or Cortex XDR Pro per TB

Description

Get your tenant license information.

Request Fields

The body of this request contains a JSON object with the following fields:
Field
Description
request_data
(
Required
) A dictionary containing the API request fields.
Send an empty dictionary.
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/incidents/update_incident/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "request_data":{ } }'

Success Response

Upon success, the HTTP response code is 200 and the API returns a reply of true.
Field
Description
Reply
List of available licenses, number of devices, and purchased addons on your tenant.
Response Example
{ "reply":{ "xsiam_premium_expiration":"<timestamp>", "purchased_xsiam_premium":{ "users":100, "gb":100, "agents":500 }, "pro_per_endpoint_expiration":"<timestamp>", "purchased_pro_per_endpoint":{ "agents":200 }, "data_enabled_pro_per_endpoint":26, "prevent_expiration":0, "purchased_prevent":0, "installed_prevent":27, "pro_tb_expiration":"<timestamp", "purchased_pro_tb":{ "tb":1 }, "installed_pro_tb":0, "compute_unit_expiration":0, "purchased_compute_unit":16, "host_insights_expiration":"<timestamp>", "enabled_host_insights":26, "purchased_host_insights":400, "forensics_expiration":0, "enabled_forensics":12 } }

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:
Field
Description
400
Bad Request. Got an invalid JSON.
401
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
402
Unauthorized access. User does not have the required license type to run this API.
403
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
500
Internal server error. A unified status for API communication type errors. For example,
test@test.com is not a valid Cortex XDR email address.
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}

Recommended For You