Get an agent deployment

GET/v5/agentex/deployments/{deployment_id}

Get a single agent deployment by ID, including its current status and Kubernetes events.

Returns the deployment record with its latest status and the associated Kubernetes events (deploy_events) observed for the release, which are useful for diagnosing why a deployment is still pending or unhealthy. Poll this after POST /v5/agentex/deployments to track the asynchronous deploy to completion. For the incremental log output rather than status and events, use GET /v5/agentex/deployments/{deployment_id}/logs. Returns 404 if no deployment with this ID exists for the caller’s account.

ParametersExpand Collapse

deployment_id: str

ReturnsExpand Collapse

class AgentexCloudDeploy: …

id: str

The unique identifier of the deployment.

account_id: str

The ID of the account that owns the given entity.

created_at: datetime

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

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

environment_config: str

YAML content of environment configuration from the environment config file.

manifest_file: str

YAML content of manifest configuration.

namespace: str

Kubernetes namespace where the deployment is deployed.

status: str

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

build_id: Optional[str]

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

deploy_events: Optional[List[AgentexCloudDeployEvent]]

Kubernetes events for this deployment.

message: Optional[str]

Full event message.

reason: Optional[str]

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

timestamp: Optional[datetime]

When the event was observed.

formatdate-time

type: Optional[str]

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

expires_at: Optional[datetime]

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[str]

Helm release name after successful deployment.

object: Optional[Literal["agentex_cloud_deploy"]]

preview_label: Optional[str]

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.

Get an agent deployment

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
agentex_cloud_deploy = client.deploy.retrieve(
    "deployment_id",
)
print(agentex_cloud_deploy.id)

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

Returns Examples

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