Licensing

Retrieve tenant license entitlements and add-on information.

Tenant license and entitlement information.

Tenant license & entitlement info

post

Returns the tenant's license and add-on entitlement information — purchased quotas, current usage/installed counts, expiration dates, add-on states, and (for Cloud / Cloud Posture licenses) a per-workload usage breakdown.

Backed by the existing licensing service: it reuses LicensingCalculatorService.get_license_status() and projects the result through TenantLicenseInfo.to_dict(). The response shape is tenant-type dependent — XSIAM, XDR, XSOAR and Xpanse tenants each return a different set of fields. The endpoint takes no parameters; send an empty body.

Note: the workload breakdown exposed here is filtered to name + usage only — it does not include billable-workload conversion, utilization percentage, over-quota flags, or tooltip breakdowns. For the Cloud Consumption dashboard license cards (with billable units and tooltips) use the /platform/cloud-consumption/v1/license-runtime/ and /platform/cloud-consumption/v1/license-posture/ endpoints instead.

Authorizations

AuthorizationstringRequired

JWT token for API authentication

Body

object · EmptyRequestOptional

Endpoints in the License group take no parameters in v1. Send an empty body (or omit the body entirely).

Responses

200

Tenant license info returned successfully. The reply shape depends on the tenant type.

application/json

Public-API envelope for get_tenant_info. The reply object shape is tenant-type dependent: XSIAM tenants get XsiamTenantLicenseInfo, XDR tenants get XdrTenantLicenseInfo, XSOAR tenants get XsoarTenantLicenseInfo, and Xpanse tenants get XpanseTenantLicenseInfo. The server selects the variant based on the authenticated tenant.

replyone ofRequired

or

or

or

400

Bad Request — the request body fails validation (missing required fields, wrong type, value out of range, unknown cloud provider, etc).

application/json

401

Unauthorized — invalid or missing authentication credentials.

application/json

403

Forbidden — the API key lacks Cloud Consumption Command Center: View permission, or the tenant does not have a Cloud license.

application/json

404

Not Found — the Cloud Consumption dashboard is disabled for this tenant or the endpoint does not exist.

application/json

429

Too Many Requests — rate limit exceeded.

application/json

500

Internal Server Error — an unexpected error occurred on the server.

application/json

post/public_api/v1/system/get_tenant_info/

POST /public_api/v1/system/get_tenant_info/ HTTP/1.1
Host: api-{{fqdn}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "reply": {
    "xsiam_enterprise_plus_expiration": "2026-01-31",
    "purchased_xsiam_enterprise_plus": {
      "users": 100,
      "gb": 500,
      "agents": 2000
    },
    "pro_per_endpoint_expiration": 0,
    "purchased_pro_per_endpoint": 0,
    "data_enabled_pro_per_endpoint": 0,
    "prevent_expiration": 0,
    "purchased_prevent": 0,
    "installed_prevent": 0,
    "attack_surface_management_expiration": "2026-01-31",
    "threat_intelligence_management_expiration": "2026-01-31"
  }
}