Admin Telemetry

Generated admin telemetry operations.

GET/v1/admin/telemetryRead server telemetryadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_telemetry

Parameters

Name	In	Type
`window`	query	`string`
`timeZone`	query	`string`
`until`	query	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "buckets": [
      {
        "end": "string",
        "partial": true,
        "start": "string"
      }
    ],
    "from": "string",
    "observedAt": 0,
    "period": "string",
    "series": {
      "key": [
        {
          "detail": "string",
          "status": "available",
          "t": 0,
          "v": 0
        }
      ]
    },
    "status": {
      "key": {
        "detail": "string",
        "status": "string",
        "value": 0
      }
    },
    "timeZone": "2026-10-18T19:30:00Z",
    "until": "string",
    "window": "string"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- bucketsarray of objectrequired
  - endstringrequired
  - partialbooleanrequired
  - startstringrequired
- fromstringrequired
- observedAtintegerrequired
- periodstringrequired
- seriesobjectrequired
  - detailstring
  - statusstringrequiredone of "available", "limited"
  - tintegerrequired
  - vnumberrequired
- statusobjectrequired
  - detailstring
  - statusstringrequired
  - valuenumberrequired
- timeZonestringrequired
- untilstringrequired
- windowstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/telemetry" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/telemetry/nowRead server telemetry nowadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_telemetry_now

Responses

200Successapplication/json

Example

{
  "data": {
    "at": 0,
    "gpuDevice": "string",
    "gpuProvider": "string",
    "memoryTotalBytes": 0,
    "memoryUsedBytes": 0,
    "metrics": {
      "key": {
        "detail": "string",
        "status": "string",
        "value": 0
      }
    }
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- atintegerrequired
- gpuDevicestring
- gpuProviderstring
- memoryTotalBytesintegerrequired
- memoryUsedBytesintegerrequired
- metricsobjectrequired
  - detailstring
  - statusstringrequired
  - valuenumberrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/telemetry/now" \
  -H "Authorization: Bearer $PORTICO_API_KEY"