Cancel deployment

POST

/api/v1/deployments/{id}/cancel

const url = 'https://api.deploybase.eu/api/v1/api/v1/deployments/example/cancel';
const options = {method: 'POST', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/deployments/example/cancel \
  --header 'Authorization: <Authorization>'

Cancels a pending, queued, or building deployment

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Deployment ID (UUID)

Responses

200

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

branch

string

build_finished_at

string

build_log

string

build_started_at

string

commit_hash

string

commit_message

string

created_at

string

created_by_email

string

deployed_at

string

file_count

integer

has_custom_404

boolean

has_spa_fallback

boolean

string

is_preview

boolean

preview_url

string

project_id

string

redirect_rules

Array<object>

object

force

boolean

from

string

status

integer

string

status

string

Allowed values: pending queued building deployed failed cancelled

team_id

string

total_bytes

integer

updated_at

string

url

string

400

Deployment cannot be cancelled

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

401

Unauthorized

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

404

Not Found

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

409

Deployment in terminal state

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string