Get a deployment

GET

/api/v1/deployments/{id}

curl --request GET \
  --url https://digize.com/api/v1/deployments/example \
  --header 'x-api-key: <x-api-key>'

• Digize

One deployment: its version, commit, status and timings.

Needs the sites:read permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

Responses

200

Done

Media typeapplication/json

object

id

required

string

siteId

required

string

worker

required

string

version

required

number

status

required

string

Allowed values: queued building deploying live failed superseded

kind

required

string

Allowed values: push manual redeploy rollback

commit

required

object

sha

required

string

message

required

string

author

required

string

branch

required

string

requestedBy

required

string | null

createdAt

required

string format: date-time

startedAt

required

Any of:

string

string format: date-time

null

null

finishedAt

required

Any of:

string

string format: date-time

null

null

duration

required

number | null

error

required

string | null

failedStage

required

Any of:

string

string

Allowed values: build deploy

null

null

canRedeploy

required

boolean

Example

{
  "status": "queued",
  "kind": "push",
  "failedStage": "build"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}