Admin endpoints for Gateway instance management

POST/v1/gateway/instance/activate

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)

Request Body (JSON)

Request Body

Property	Type	Required
`activationToken`	`string`	No
`deviceFingerprintHash`	`string`	No
`instanceId`	`string`	No

Responses

200 Gateway instance activated successfully

Property	Type	Description
`status`	`string`
`instanceId`	`string`
`tenantId`	`string`
`planTier`	`string`
`activatedAt`	`string`
`expiresAt`	`string`

default An unexpected error response.

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

Request

curl -X POST "http://localhost:8089/v1/gateway/instance/activate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"activationToken":"string","deviceFingerprintHash":"string","instanceId":"string"}'

const response = await fetch("http://localhost:8089/v1/gateway/instance/activate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "activationToken": "string",
  "deviceFingerprintHash": "string",
  "instanceId": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/gateway/instance/activate",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "activationToken": "string",
  "deviceFingerprintHash": "string",
  "instanceId": "string"
},
)
data = response.json()

Response

{
  "status": "string",
  "instanceId": "string",
  "tenantId": "string",
  "planTier": "string",
  "activatedAt": "2024-01-01T00:00:00Z",
  "expiresAt": "2024-01-01T00:00:00Z"
}

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