Get Gateway Instance Status

GET/v1/gateway/instance/status

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Responses

200 Gateway instance status

Property	Type	Description
`status`	`string`
`activated`	`boolean`
`instanceId`	`string`
`activatedAt`	`string`
`licenseState`	`object`
`message`	`string`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X GET "http://localhost:8089/v1/gateway/instance/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/gateway/instance/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/gateway/instance/status",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "status": "string",
  "activated": true,
  "instanceId": "string",
  "activatedAt": "2024-01-01T00:00:00Z",
  "licenseState": {
    "instanceId": "string",
    "tenantId": "string",
    "planTier": "LICENSE_TYPE_UNSPECIFIED",
    "features": [
      {
        "name": "string",
        "enabled": true
      }
    ],
    "usageLimits": [
      {
        "type": "USAGE_LIMITS_TYPE_UNSPECIFIED",
        "value": "string"
      }
    ],
    "expiresAt": "2024-01-01T00:00:00Z",
    "refreshIntervalSecs": 0,
    "gracePeriodSecs": 0,
    "status": "LICENSE_STATUS_UNSPECIFIED"
  },
  "message": "string"
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}