Skip to content
ShipSquares

/deployments/{id}/cancel

POST
/deployments/{id}/cancel
 
curl --request POST \
  --url https://example.com/api/v1/deployments/example/cancel

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
id
required
string
appId
required
string
organizationId
required
string
status
required
Any of:
string
Allowed values: queued
trigger
required
Any of:
string
Allowed values: push
commitAfter
required
Any of:
string
errorMessage
required
Any of:
string
meta
required
Any of:
object
image
string
container
string
hostPort
string
host
string
containerPort
integer
url
string
queuedAt
required
string format: date-time
startedAt
required
Any of:
string format: date-time
finishedAt
required
Any of:
string format: date-time
Example 
{
  "status": "queued",
  "trigger": "push"
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

409

Section titled “409 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}