Create a deployment
POST
/v1/deploymentsCopyStarts a deployment for the API key's site from the latest commit on its configured branch. A newer deployment supersedes any queued or building deployment for the same site. Every accepted build counts toward the organization's build activity, including builds that are later canceled. The Free daily allowance is shared across the organization, while Pro includes unlimited builds for normal product use.
Header
Authorization
stringrequiredA site-scoped key created from the Radiant dashboard.
Responses
202
The deployment was accepted and dispatched.id
string (uuid)requiredsiteId
string (uuid)requiredstatus
enum<string>requiredOptions:
queued, building, success, failed or canceledtrigger
stringrequiredThe workflow that created the deployment.
commit
objectrequiredsha
stringrequiredmessage
stringnullrequiredfailure
object | nullrequiredOne of these variants applies.
object
message
stringrequiredcreatedAt
string (date-time)requiredupdatedAt
string (date-time)required401
The request is missing a valid, active Radiant API key.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any403
The API key does not have the scope required by the operation.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any404
The resource does not exist or is outside the API key's site scope.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any409
The site repository or its credentials are not ready for deployment.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any429
The organization cannot accept more builds until its build capacity resets.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any500
Radiant could not complete the request because of an internal error.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any502
Radiant could not load the configured repository from GitHub.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any503
Radiant created the deployment record but could not dispatch its build.error
objectrequiredcode
stringrequiredmessage
stringrequireddetails
object[key: string]
any