API reference · Dedicated endpoints
An endpoint's replicas, newest first
/v1/endpoints/{dedicated_endpoint_id}/replicas- TypeScript
client.dedicatedEndpoints.listReplicas()- Python
client.dedicated_endpoints.list_replicas()- CLI
hayonix endpoints replicas
Live replicas by default; pass live=false to include removed ones with their termination reason (at most the 200 most recent).
Project API key (Authorization: Bearer sk_…), or a console session. Requires the dedicated_endpoint:read permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/endpoints/ded_01jc5zq4m8k3v6x9t2w7r0b1e4/replicas" \
-H "Authorization: Bearer $API_KEY"Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Path parameters
dedicated_endpoint_idstringrequiredID of the dedicated endpoint
ID with prefix ded_
Query parameters
limitinteger1–200, default 50
1–200
cursorstring`next_cursor` of the previous page
up to 200 characters
liveboolean | stringOnly replicas not terminated (default true)
Response
200 a page of results — Replicas
The items of this page.
ShowHide 12 fields of
dataobjectstringrequiredAlways `endpoint_replica`: the type of this object
One of
endpoint_replicaidstringrequiredUnique ID (`rpl_…`)
ID with prefix rpl_
deployment_idstring | nullrequiredID of the deployment
statestringrequired`starting`: downloading weights and loading (not billed). `ready`: passed the engine health check, taking traffic, billed per second. `draining`: leaving (no new requests).
One of
startingreadyunhealthydrainingterminatedhardwareobjectrequiredThe hardware the replica runs on
ShowHide 1 field of
hardwareskustringrequiredHardware type code
node_idstring | nullrequiredThe node the replica is placed on (null until it is placed, and once removed)
ready_atstring (date-time) | nullrequiredTime ready (ISO 8601, UTC)
health_messagestring | nullrequiredThe engine's health check failure that made the replica `unhealthy`; null once it is ready again, or if it never failed one
drain_reasonstring | nullrequiredWhy the replica is draining: `stopped` (the endpoint was stopped or deleted, or its deployment removed) or `scale_down` (demand fell); null when not draining
termination_reasonstring | nullrequiredWhy the replica was removed, for example `drained`, `startup_timeout` (not ready within the startup limit) or `unhealthy` (failing health checks for too long); null while it is live
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
terminated_atstring (date-time) | nullrequiredTime terminated (ISO 8601, UTC)
next_cursorstring | nullrequiredPass as `cursor` for the next page; null on the last page.
Example response
{
"data": [
{
"object": "endpoint_replica",
"id": "rpl_01jc5zq4m8k3v6x9t2w7r0b1e4",
"deployment_id": "string",
"state": "starting",
"hardware": {
"sku": "string"
},
"node_id": "string",
"ready_at": "2026-01-01T00:00:00.000Z",
"health_message": "string",
"drain_reason": "string",
"termination_reason": "string",
"created_at": "2026-01-01T00:00:00.000Z",
"terminated_at": "2026-01-01T00:00:00.000Z"
}
],
"next_cursor": "string"
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |