Cancel a deploy

POST

/api/orgs/{org}/projects/{project}/environments/{env}/runs/{number}/cancel

curl --request POST \
  --url https://api-dev.wrktr.com/api/orgs/example/projects/example/environments/example/runs/example/cancel \
  --header 'Authorization: Bearer <token>'

Stops a queued or running run.

Authorizations

• bearer

Parameters

Path Parameters

org

required

string

project

required

string

env

required

string

number

required

string

Responses

200

RunView

Media typeapplication/json

object

id

required

string

environment

required

string

number

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

commit

required

string

title

required

string

branch

required

Any of:

string

string

null

null

trigger

required

string

Allowed values: land promote rollback rerun

by

required

Any of:

string

string

null

null

createdAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

startedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

finishedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

state

required

string

Allowed values: queued running passed failed error cancelled

message

required

Any of:

string

string

null

null

base

required

Any of:

string

string

null

null

steps

required

Array<object>

object

name

required

string

run

required

string

state

required

string

Allowed values: pending running passed failed error skipped cancelled

startedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

finishedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

exitCode

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

tail

required

string

hasLog

required

boolean

verify

Any of:

object

Any of:

object

object

state

required

string

Allowed values: checking serving not-serving unverified

checkedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

seen

required

Any of:

string

string

null

null

message

required

Any of:

string

string

null

null

null

null

null

null

workers

Any of:

Array<object>

Array<object>

object

version

required

string

compatibilityDate

required

Any of:

string

string

null

null

null

null

Example

{
  "number": "Infinity",
  "trigger": "land",
  "createdAt": "Infinity",
  "startedAt": "Infinity",
  "finishedAt": "Infinity",
  "state": "queued",
  "steps": [
    {
      "state": "pending",
      "startedAt": "Infinity",
      "finishedAt": "Infinity",
      "exitCode": "Infinity"
    }
  ],
  "verify": {
    "state": "checking",
    "checkedAt": "Infinity"
  }
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | NotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: NotFound

what

required

string

Example

{
  "_tag": "ProjectNotFound"
}

409

RunRefused

Media typeapplication/json

object

_tag

required

string

Allowed values: RunRefused

message

required

string

Example

{
  "_tag": "RunRefused"
}