Skip to main content
GET
Get an agent service instance

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

deployment_id
string
required

Agent deployment ID

service_id
string
required

Agent service instance ID

Response

Agent service instance

id
string
required
Example:

"adsvc_1234abcd"

deployment_id
string
required
version_id
string
required
status
enum<string>
required
Available options:
starting,
ready,
unhealthy,
stopping,
stopped,
failed
port
integer
required
Required range: 1 <= x <= 65535
created_at
string<date-time>
required
updated_at
string<date-time>
required
machine_id
string | null
process_id
integer<uint32> | null
public_url
string<uri> | null

Dynamic public URL for the ready service. Signed edge URLs contain bearer credentials such as edge_token; do not log or persist them. A null value means the service is not ready, has no backing machine, or permissions.public_url is disabled.

readiness_status
object | null

Server-recorded readiness/lifecycle status detail for the service instance. Key set varies by lifecycle phase; deliberately open.

failure_reason
string | null
started_at
string<date-time> | null
stopped_at
string<date-time> | null
idempotency_key
string | null