Deployments

Get deployment status

Get the status of a deployment from the status ID returned by Trigger deployment. Authenticate with a Velu API key.

GET/v1/update/{deploymentId}

Authorizations

BearerAuthorizationstringrequiredheader
Create a key in the dashboard under Settings → API keys. Send it as a Bearer token.

Path Parameters

deploymentIdintegerrequired
The status ID returned by Trigger deployment.

Response

200application/json

Deployment status.

idinteger
statusenum<string>
One of `queued`, `building`, `successful`, or `failed`.
triggerstring
error_messagestring
commit_shastring
commit_messagestring
created_atstring<date-time>
started_atstring<date-time>
finished_atstring<date-time>
site_urlstring
401application/json

Missing or invalid API key.

error_codestring
messagestring
404application/json

Error response

error_codestring
messagestring
Was this page helpful?