Sign in
latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

b2c3116e633e

Unleash Edge

Register Edge observability metrics.

Enterprise feature

Registers Edge observability metrics from downstream Edge instances to aggregate a comprehensive status view of connected Edges.

post/api/client/metrics/edge

Request body

identifierstring required

The ID of the Edge process, typically a ULID. Newly generated for each restart of the instance.

appNamestring required

The name of the application, configured by the user, typically persistent across restarts of Edge.

regionstring nullable

Which region the Edge instance is running in. Set to AWS_REGION by default (if present).

edgeVersionstring required

Which version (semver) of Edge is the Edge instance running.

startedstring date-time required

RFC3339 timestamp for when the Edge instance was started.

connectedStreamingClientsnumber required

How many streaming clients are connected to the Edge instance.

hosting'hosted' | 'self-hosted' | 'enterprise-self-hosted'

A marker that tells Unleash whether this Edge instance is self-hosted, enterprise self-hosted, or hosted by Unleash.

Example request

{
  "identifier": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "appName": "unleash-edge-us-east-1",
  "region": "us-east-1",
  "edgeVersion": "19.6.3",
  "processMetrics": {
    "cpuUsage": 54.54,
    "memoryUsage": 34000432
  },
  "latencyUpstream": {
    "features": {
      "p99": 34.5
    },
    "metrics": {
      "p99": 34.5
    },
    "edge": {
      "p99": 34.5
    }
  },
  "connectionConsumptionSinceLastReport": {
    "features": [
      {
        "meteredGroup": "default",
        "dataPoints": [
          {
            "interval": [
              0,
              15000
            ]
          }
        ]
      }
    ],
    "metrics": [
      {
        "meteredGroup": "default",
        "dataPoints": [
          {
            "interval": [
              0,
              15000
            ]
          }
        ]
      }
    ]
  },
  "requestConsumptionSinceLastReport": [
    {
      "meteredGroup": "default",
      "requests": 10000
    }
  ]
}

Response

This response has no body.