compute
deployment

Retrieve a deployment

get/compute/{connection_id}/deployment/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/compute/{connection_id}/deployment/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Deployment

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the deployment

created_atstring date-time

When the deployment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the deployment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

service_idstring

The service this deployment belongs to

status'QUEUED' | 'BUILDING' | 'DEPLOYING' | 'LIVE' | 'FAILED' | 'CANCELED' | 'SUPERSEDED' | 'OTHER'

Normalized deployment status; set to CANCELED on update to cancel

trigger'GIT' | 'MANUAL' | 'API' | 'ROLLBACK' | 'OTHER'

What started the deployment

environment'PRODUCTION' | 'PREVIEW' | 'DEVELOPMENT' | 'OTHER'

Target environment

commit_identifierstring

Source commit SHA (reference to RepoCommit)

commit_messagestring

Source commit message

branchstring

Source branch

imagestring

Container image deployed, for image-based services

urlstring

URL where this deployment is served

started_atstring date-time

When the build started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

finished_atstring date-time

When the deployment finished (live, failed or canceled) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

errorstring

Failure description

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.