Status API
Request tenant status by ID.
The Status API includes two endpoints, and the second endpoint is for a particular tenant.
Status API
Request
GET {ApplicationURL}/status/tenant/{{tenantID}}
| Name | Required | Description |
|---|---|---|
ContentType |
Yes | application/json |
Response
{
"Status": "Green",
"IsExternalQueue": false,
"Events queue size": 0,
"Matching queue size": 0
}Here is the endpoint for a particular tenant.
Request
GET {applicationURL}/reltio/status/<tenantID>| Parameter | Required | Details |
|---|---|---|
| Content-Type | Yes | application/json |
Response
{
"Status": "Green",
"IsExternalQueue": false,
"Events queue size": 0,
"Matching queue size": 0
}- Queue sizes for the main and matching queue of the particular tenant.
- Tenant state-red, yellow green, which stand for:
- Red state: tenant did not pass healthchecks on the instance, or the tenant has a queue size more than the RED threshold.
- Yellow state: tenant has non-empty queues.
- Green state: tenant is available, queues are empty.