List agent deployments

GET/v5/agentex/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 limit=1 to fetch the latest deployment for that label. This lists deployments (the running or attempted agent instances); to list the image builds they run, use the agentex builds API.

Query ParametersExpand Collapse

agent_name: optional string

Filter deployments by agent name (via associated build)

build_id: optional string

Filter deployments by build ID

ending_before: optional string

limit: optional number

maximum10000

minimum1

preview_label: optional string

Filter deployments by preview label (e.g. branch name). The label is non-unique — many deployments can share it. Combine with limit=1 to get the latest deploy for that label.

sort_by: optional string

sort_order: optional SortOrder

One of the following:

"asc"

"desc"

starting_after: optional string

ReturnsExpand Collapse

has_more: boolean

Whether there are more items left to be fetched.

items: array of AgentexCloudDeploy { id, account_id, created_at, 11 more }

id: string

The unique identifier of the deployment.

account_id: string

The ID of the account that owns the given entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

environment_config: string

YAML content of environment configuration from the environment config file.

manifest_file: string

YAML content of manifest configuration.

namespace: string

Kubernetes namespace where the deployment is deployed.

status: string

Deployment status: pending, running, completed, failed, or cancelled.

build_id: optional string

The build_id of the cloud build that produced the deployed image.

deploy_events: optional array of AgentexCloudDeployEvent { message, reason, timestamp, type }

Kubernetes events for this deployment.

message: optional string

Full event message.

reason: optional string

Short reason, e.g. ‘Pulling’, ‘Scheduled’.

timestamp: optional string

When the event was observed.

formatdate-time

type: optional string

Event type, e.g. ‘Normal’ or ‘Warning’.

expires_at: optional string

When this deployment will be cleaned up. Always set on preview deployments (defaults to 8 hours from creation if the request omits it). Null on non-preview deployments — they have no TTL.

formatdate-time

helm_release_name: optional string

Helm release name after successful deployment.

object: optional "agentex_cloud_deploy"

preview_label: optional string

Non-unique grouping label for preview deployments. Filter ?preview_label=X&limit=1 returns the latest deploy for the label. Sanitized (lowercase alphanumeric + hyphens) and capped at 30 characters.

total: number

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

limit: optional number

The maximum number of items to return.

object: optional "list"

List agent deployments

curl https://api.egp.scale.com/v5/agentex/deployments \
    -H "x-api-key: $SGP_API_KEY"

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "environment_config": "environment_config",
      "manifest_file": "manifest_file",
      "namespace": "namespace",
      "status": "status",
      "build_id": "build_id",
      "deploy_events": [
        {
          "message": "message",
          "reason": "reason",
          "timestamp": "2019-12-27T18:11:19.117Z",
          "type": "type"
        }
      ],
      "expires_at": "2019-12-27T18:11:19.117Z",
      "helm_release_name": "helm_release_name",
      "object": "agentex_cloud_deploy",
      "preview_label": "preview_label"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "environment_config": "environment_config",
      "manifest_file": "manifest_file",
      "namespace": "namespace",
      "status": "status",
      "build_id": "build_id",
      "deploy_events": [
        {
          "message": "message",
          "reason": "reason",
          "timestamp": "2019-12-27T18:11:19.117Z",
          "type": "type"
        }
      ],
      "expires_at": "2019-12-27T18:11:19.117Z",
      "helm_release_name": "helm_release_name",
      "object": "agentex_cloud_deploy",
      "preview_label": "preview_label"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}