Deployment - Cloud 66 API V3 | Cloud 66 API Documentation

Deployments represent the deployment history and operations for your stacks. Each deployment tracks the git commit, trigger source, outcome, and timing information.

Model

idinteger

The unique identifier of the deployment.

triggered_bystring

The user or system that triggered this deployment.

triggered_viaobject

Information about how the deployment was triggered, including code and meaning (web, api, or hook).

started_atdatetime

The date and time when the deployment started, in ISO 8601 format.

finished_atdatetime

The date and time when the deployment finished, in ISO 8601 format.

outcomeobject

The deployment outcome, including code and meaning (pending, success, or failed).

git_hashstring

The git commit hash for this deployment.

git_refstring

The git reference (branch or tag) used for this deployment.

deploy_sessionstring

The unique session identifier for this deployment.

deploy_typeobject

The type of deployment, including code and meaning (build, redeploy, scale, first_build, or revert).

is_headboolean

Whether this deployment is the current HEAD deployment.

is_liveboolean

Whether this deployment is currently live.

revertedboolean

Whether this deployment has been reverted.

reverted_bystring

The user who reverted this deployment, if applicable.

reverted_atdatetime

The date and time when this deployment was reverted, in ISO 8601 format.

is_deployingboolean

Whether this deployment is currently in progress.

commit_urlstring

The URL to view the git commit for this deployment.

snapshot_uuidstring

The UUID of the snapshot associated with this deployment.

Example

{
  "id": 456789,
  "triggered_by": "john@example.com",
  "triggered_via": {
    "code": "web",
    "meaning": "Web Interface"
  },
  "started_at": "2024-02-15T14:30:00Z",
  "finished_at": "2024-02-15T14:45:30Z",
  "outcome": {
    "code": "success",
    "meaning": "Successful"
  },
  "git_hash": "a1b2c3d4e5f6789012345678901234567890abcd",
  "git_ref": "main",
  "deploy_session": "deploy-session-uuid-12345",
  "deploy_type": {
    "code": "redeploy",
    "meaning": "Redeploy"
  },
  "is_head": true,
  "is_live": true,
  "reverted": false,
  "reverted_by": null,
  "reverted_at": null,
  "is_deploying": false,
  "commit_url": "https://github.com/example/repo/commit/a1b2c3d4e5f6789012345678901234567890abcd",
  "snapshot_uuid": "550e8400-e29b-41d4-a716-446655440000"
}

Edit this page