Deployment

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (deployments/{id})
source DeploymentSource   Origin system that created this deployment event
status DeploymentStatus   Current status of the deployment (denormalized from latest status event)
labels map<string, string>   Flexible key-value dimensions for categorizing deployments
create_time timestamp OUTPUT_ONLY When the deployment record was created
update_time timestamp OUTPUT_ONLY When the deployment record was last updated
delete_time timestamp OUTPUT_ONLY When the deployment was soft-deleted (null if active)
start_time timestamp   When the deployment actually started executing
complete_time timestamp   When the deployment completed (success, failure, or error)
external_id string   External identifier from the source system (e.g. GitHub deployment ID)
external_url string   URL to view this deployment in the source system
description string   Human-readable description or title of the deployment

Example

{
  "name": "deployments/8981264b-cf59-434c-95a0-1ec58b502226",
  "source": "DEPLOYMENT_SOURCE_GITHUB",
  "status": "DEPLOYMENT_STATUS_SUCCESS",
  "labels": {
    "deployer": "octocat",
    "environment": "production",
    "ref": "main",
    "repository": "acme/backend",
    "sha": "acb26d1df10035fdde98ceb7f29d0e9276367fcb"
  },
  "createTime": "2026-02-13T01:04:29.873715Z",
  "updateTime": "2026-02-13T01:08:40.953822Z",
  "startTime": "2026-02-13T01:04:28Z",
  "completeTime": "2026-02-13T01:08:39Z",
  "externalId": "gh-3831677370",
  "externalUrl": "https://github.com/acme/backend/deployments"
}

Common labels auto-extracted from GitHub webhooks:

Label Example Description
repository acme-corp/backend Repository full name
environment production Deployment environment
ref main Git reference (branch or tag)
sha abc123... Commit SHA being deployed
deployer octocat User who triggered the deployment

Deployment Source

Value Description
DEPLOYMENT_SOURCE_UNSPECIFIED Default value, not used
DEPLOYMENT_SOURCE_GITHUB Deployment originated from GitHub
DEPLOYMENT_SOURCE_MANUAL Deployment was recorded manually

Deployment Status

Value Description
DEPLOYMENT_STATUS_UNSPECIFIED Default value, not used
DEPLOYMENT_STATUS_PENDING Deployment is pending
DEPLOYMENT_STATUS_QUEUED Deployment is queued
DEPLOYMENT_STATUS_IN_PROGRESS Deployment is currently executing
DEPLOYMENT_STATUS_SUCCESS Deployment completed successfully
DEPLOYMENT_STATUS_FAILED Deployment failed
DEPLOYMENT_STATUS_ERROR Deployment encountered an error
DEPLOYMENT_STATUS_INACTIVE Deployment is inactive

Deployment Status Event

Resource name pattern: deployments/{deployment_id}/status-events/{status_event_id}

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (deployments/{id}/status-events/{id})
deployment string REQUIRED Parent deployment resource name
status DeploymentStatus   The status at this point in time
description string   Context for this status change
event_time timestamp   When this status was recorded in the source system
external_url string   URL to view this status event in the source system
create_time timestamp OUTPUT_ONLY When this status event record was created
update_time timestamp OUTPUT_ONLY When this status event record was last updated
delete_time timestamp OUTPUT_ONLY When this status event was soft-deleted (null if active)

Deployment Monitor Evaluation

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (deployment-monitor-evaluations/{id})
create_time timestamp OUTPUT_ONLY When the evaluation was created
update_time timestamp OUTPUT_ONLY When the evaluation was last updated
delete_time timestamp OUTPUT_ONLY When the evaluation was soft-deleted (null if active)
session_name string   Reference to the agent session running this evaluation (agents/{agent}/sessions/{session})
status DeploymentMonitorEvaluationStatus   Current status of the evaluation
github_run_id integer   GitHub Actions workflow run ID that triggered the deployment
environment string   The environment being deployed to (e.g. production)
repository string   Repository in owner/name format (e.g. acme-corp/backend)
head_sha string   The commit SHA being deployed
base_sha string   The base commit SHA (previous deployment)
pr_number integer   PR number if this deployment is from a PR merge (0 if not)
deployment_time timestamp   When the deployment started
summary string   Summary of the monitoring period written by the agent on completion
overall_status string   Overall outcome: successful, warning, or incident

Deployment Monitor Evaluation Status

Value Description
DEPLOYMENT_MONITOR_EVALUATION_STATUS_UNSPECIFIED Default value, not used
DEPLOYMENT_MONITOR_EVALUATION_STATUS_RUNNING Evaluation is currently running
DEPLOYMENT_MONITOR_EVALUATION_STATUS_COMPLETED Evaluation has completed

This site uses Just the Docs, a documentation theme for Jekyll.