Skip to content
sgp
API Reference

Deploy

Deploy a built agent image
client.Deploy.New(ctx, body) (*AgentexCloudDeploy, error)
POST/v5/agentex/deployments
Get an agent deployment
client.Deploy.Get(ctx, deploymentID) (*AgentexCloudDeploy, error)
GET/v5/agentex/deployments/{deployment_id}
List agent deployments
client.Deploy.List(ctx, query) (*CursorPage[AgentexCloudDeploy], error)
GET/v5/agentex/deployments
Get agent deployment logs
client.Deploy.Logs(ctx, deploymentID, query) (*DeployLogsResponse, error)
GET/v5/agentex/deployments/{deployment_id}/logs
Delete and tear down a deployment
client.Deploy.Delete(ctx, deploymentID) (*AgentexCloudDeploy, error)
DELETE/v5/agentex/deployments/{deployment_id}
ModelsExpand Collapse
type AgentexCloudDeploy struct{…}
ID string

The unique identifier of the deployment.

AccountID string

The ID of the account that owns the given entity.

CreatedAt Time

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

formatdate-time
CreatedBy Identity

The identity that created the entity.

ID string
Type IdentityType
One of the following:
const IdentityTypeUser IdentityType = "user"
const IdentityTypeServiceAccount IdentityType = "service_account"
Object IdentityObjectOptional
EnvironmentConfig string

YAML content of environment configuration from the environment config file.

ManifestFile 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.

BuildID stringOptional

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

DeployEvents []AgentexCloudDeployEventOptional

Kubernetes events for this deployment.

Message stringOptional

Full event message.

Reason stringOptional

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

Timestamp TimeOptional

When the event was observed.

formatdate-time
Type stringOptional

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

ExpiresAt TimeOptional

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
HelmReleaseName stringOptional

Helm release name after successful deployment.

Object AgentexCloudDeployObjectOptional
PreviewLabel stringOptional

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.

type AgentexCloudDeployEvent struct{…}

Slim event representation for the API response.

Message stringOptional

Full event message.

Reason stringOptional

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

Timestamp TimeOptional

When the event was observed.

formatdate-time
Type stringOptional

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