List agent deployments

List the account’s agent deployments, with pagination and optional filters.

Returns the deployments the caller is authorized to read. Optionally filter by build_id, by agent_name (matched through each deployment’s associated build), or by preview_label. A preview_label is non-unique — many deployments can share one (for example every deploy for a branch) — so combine it with sort_order=desc&limit=1 to fetch the latest deployment for that label; the default order is oldest first. This lists deployments (the running or attempted agent instances); to list the image builds they run, use the agentex builds API.

GET /v5/agentex/deployments

List agent deployments

cURL

curl --request GET \
  --url https://api.egp.scale.com/v5/agentex/deployments \
  --header 'x-api-key: <api-key>'

200

{
  "items": [
    {
      "id": "<string>",
      "namespace": "<string>",
      "manifest_file": "<string>",
      "environment_config": "<string>",
      "status": "<string>",
      "account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": "<string>",
        "type": "user",
        "object": "identity"
      },
      "object": "agentex_cloud_deploy",
      "build_id": "<string>",
      "image_digest": "<string>",
      "helm_release_name": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "preview_label": "<string>",
      "deploy_events": [
        {
          "type": "<string>",
          "reason": "<string>",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "total": 123,
  "has_more": true,
  "object": "list",
  "limit": 100
}

Authorizations

x-api-key · string · header · required

Headers

x-selected-account-id · string | null

Query Parameters

build_id · string | null

Filter deployments by build ID

agent_name · string | null

Filter deployments by agent name (via associated build)

preview_label · string | null

Filter deployments by preview label (e.g. branch name). The label is non-unique. The default order is oldest first, so combine with sort_order=desc&limit=1 to get the latest deploy for that label.

starting_after · string | null

ending_before · string | null

limit · integer · default: 100

Required range: 1 <= x <= 10000

sort_by · string | null

sort_order · enum<string> | null · default: asc

Available options: asc, desc

Response

200

application/json

Successful Response

items · Items · object[] · required

Show child attributes

total · integer · required

The total of items that match the query. This is greater than or equal to the number of items returned.

has_more · boolean · required

Whether there are more items left to be fetched.

object · string · default: list

Allowed value: "list"

limit · integer · default: 100

The maximum number of items to return.