Skip to content

Get Deployment by ID

GET/deployment-history/{deployment_id}

Get a deployment record by its unique ID.

Path ParametersExpand Collapse
deployment_id: string
ReturnsExpand Collapse
DeploymentHistory object { id, agent_id, author_email, 5 more }

API schema for deployment history.

id: string

The unique identifier of the deployment record

agent_id: string

The ID of the agent this deployment belongs to

author_email: string

Email of the commit author

author_name: string

Name of the commit author

branch_name: string

Name of the branch

build_timestamp: string

When the build was created

formatdate-time
commit_hash: string

Git commit hash for this deployment

deployment_timestamp: string

When this deployment was first seen in the system

formatdate-time

Get Deployment by ID

curl http://localhost:5003/deployment-history/$DEPLOYMENT_ID \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
{
  "id": "id",
  "agent_id": "agent_id",
  "author_email": "author_email",
  "author_name": "author_name",
  "branch_name": "branch_name",
  "build_timestamp": "2019-12-27T18:11:19.117Z",
  "commit_hash": "commit_hash",
  "deployment_timestamp": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "id",
  "agent_id": "agent_id",
  "author_email": "author_email",
  "author_name": "author_name",
  "branch_name": "branch_name",
  "build_timestamp": "2019-12-27T18:11:19.117Z",
  "commit_hash": "commit_hash",
  "deployment_timestamp": "2019-12-27T18:11:19.117Z"
}