Skip to content
AACSearch

Read subscription and quota state for this installation

Read subscription and quota state for this installation. Runtime credentials are installation-scoped and cannot authenticate against the tenant API.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
GET
/cms/runtime/entitlement

Read subscription and quota state for this installation. Runtime credentials are installation-scoped and cannot authenticate against the tenant API.

Header Parameters

X-AACSEARCH-INSTALLATION-KEY*string

Dedicated installation credential, issued once in Console.

Match^aac_install_[a-f0-9]{64}$
X-AACSEARCH-INSTALLATION-ORIGIN*string

HTTPS origin pinned to this installation; clones require another installation.

Formaturi

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/cms/runtime/entitlement" \  -H "X-AACSEARCH-INSTALLATION-KEY: string" \  -H "X-AACSEARCH-INSTALLATION-ORIGIN: http://example.com"
{  "plan": {    "id": "string",    "name": "string",    "status": "none",    "expires_at": 0,    "trial_ends_at": 0,    "cancel_at_period_end": true,    "days_left": 0  },  "features": [    "search",    "synonyms",    "curation",    "recommendations",    "assistants",    "voice",    "image_search"  ],  "quota": {    "used": 0,    "limit": 0,    "remaining": 0,    "exhausted": true,    "resets_at": 0  },  "credits": {    "balance": 0,    "reserved": 0,    "available": 0,    "exhausted": true  },  "suspended": true,  "suspension_reason": "payment"}

Read the configuration of this installation GET

Read the configuration of this installation. Runtime credentials are installation-scoped and cannot authenticate against the tenant API.

Report discovery and acknowledge an applied configuration POST

Report discovery and acknowledge an applied configuration. Runtime credentials are installation-scoped and cannot authenticate against the tenant API.