Documentation | Deploy › List Deployments

Deploy

deploy

Methods

Create Deployment ->

AgentexCloudDeploy

post/v5/agentex/deployments

Create a new deployment.

Submits a deployment request. The deployment will:

Parse and merge configuration files
Create a Kubernetes Job running helm install
Wait for deployment completion
Return results

Get Deployment ->

AgentexCloudDeploy

get/v5/agentex/deployments/{deployment_id}

Get a deployment by its ID.

List Deployments -> CursorPage<

AgentexCloudDeploy

get/v5/agentex/deployments

List all deployments with pagination and optional filters.

query Parameters

agent_name: string

Optional

Filter deployments by agent name (via associated build)

build_id: string

Optional

Filter deployments by build ID

ending_before: string

Optional

limit: number

Optional

(maximum: 10000, minimum: 1, default: 100)

preview_label: string

Optional

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: string

Optional

sort_order:

SortOrder

Optional

starting_after: string

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

AgentexCloudDeploy

total: number

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

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

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

200Example

{
  "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"
}

Get Deployment Logs -> { deployment_id, has_more, lines, 1 more... }

get/v5/agentex/deployments/{deployment_id}/logs

Get structured log lines for a deployment with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

First call: no cursor
Subsequent calls: cursor=next_cursor from the previous response
Stop polling when the deployment reaches a terminal status

Delete Deployment ->

AgentexCloudDeploy

delete/v5/agentex/deployments/{deployment_id}

Soft-delete a deployment. Marks it as deleted and triggers K8s resource cleanup.

Domain types

AgentexCloudDeploy = { id, account_id, created_at, 11 more... }

AgentexCloudDeployEvent = { message, reason, timestamp, 1 more... }

Slim event representation for the API response.

DeployLogsResponse = { deployment_id, has_more, lines, 1 more... }

Response containing structured deployment log lines with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

First call: no after_id
Subsequent calls: after_id=next_cursor from previous response
Stop polling when has_more is False and the deployment reaches a terminal status