POST/deploy

Deploy

Deploy by tag or UUID using query parameters or a JSON body.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 parameters
tagstringoptional
Tag name(s). Comma separated list is also accepted.
uuidstringoptional
Resource UUID(s). Comma separated list is also accepted.
forcebooleanoptional
Force rebuild (without cache)
printegeroptional
Pull Request Id for deploying specific PR builds. Cannot be used with tag parameter.
pull_request_idintegeroptional
Preview deployment identifier. Alias of pr.
docker_tagstringoptional
Docker image tag for Docker Image preview deployments. Requires pull_request_id.

3 status codes
200Get deployment(s) UUID's
deploymentsarray<object>optional
400Invalid token.
messagestringoptional
401Unauthenticated.
messagestringoptional

Error handling

A 400 is returned: Invalid token. A 401 is returned: Unauthenticated.