Skip to main content
POST
deploy.deployment.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
project
string
required

The project to deploy: its id or name, as returned by deploy.projects.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
repository
object
required

The git repository to build: { host: "github" | "bitbucket", owner, name } or { host: "gitlab", id }.

ref
string
required

Branch or tag to build.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9._/-]{1,250}$
sha
string

Exact commit to build, 7 to 64 hex characters. The head of ref when omitted.

Required string length: 1 - 64
Pattern: ^[0-9a-f]{7,64}$
environment
enum<string> | null

"production" serves the build on your production domains once ready; "preview" does not. Default "preview".

Available options:
production,
preview

Response

The result

id
string
required

The deployment's id. Pass it to deploy.deployment.get or deploy.deployment.promote.

url
string

The deployment's own address.

state
enum<string>

Build and serving state.

Available options:
queued,
initializing,
building,
ready,
error,
canceled,
blocked,
deleted
environment
string

"production", "preview", or a custom environment name.

createdAt
string

When it was created, ISO 8601.

readyAt
string

When it became ready, ISO 8601.

branch
string

Git branch it was built from.

commitSha
string

Git commit it was built from.

errorCode
string

Short machine code when the build failed.

ref
string

Reference to what this call created. Pass it as ref to deploy.deployment.get.