Observability#

Observability metrics for cloud instances

List available metric panels for a cloud instance#

GET/organizations/{org_id}/cloud/instances/{instance_id}/metrics/panels

Parameters#

NameTypeLocationRequiredDescription
org_idstringpathYesOrganization ID
instance_idstringpathYesCloud instance ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/metrics/panels" \
-H "Authorization: Bearer YOUR_TOKEN"

Responses#

{
  "panels": [
    {
      "id": "string",
      "title": "string",
      "unit": "string",
      "group_by": "string"
    }
  ]
}

Query one metric panel for a cloud instance#

GET/organizations/{org_id}/cloud/instances/{instance_id}/metrics/query

Parameters#

NameTypeLocationRequiredDescription
org_idstringpathYesOrganization ID
instance_idstringpathYesCloud instance ID
panelstringqueryYes
fromstringqueryYes
tostringqueryYes
stepstringqueryNo

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/instances/550e8400-e29b-41d4-a716-446655440000/metrics/query?panel=string&from=2026-01-01T00:00:00Z&to=2026-01-01T00:00:00Z&step=string" \
-H "Authorization: Bearer YOUR_TOKEN"

Responses#

{
  "panel_id": "string",
  "unit": "string",
  "group_by": "string",
  "range": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-01-01T00:00:00Z",
    "step": "string"
  },
  "series": [
    {
      "labels": {},
      "points": [
        {
          "t": "2026-01-01T00:00:00Z",
          "v": 0
        }
      ]
    }
  ]
}