Cancel an active Takeover

POST

/api/v1/takeovers/{id}/cancel

curl --request POST \
  --url https://example.com/api/v1/takeovers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "reason": "example" }'

Requires an authenticated dashboard user.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

reason

string

<= 1000 characters

Example^generated

{
  "reason": "example"
}

Responses

200

Takeover cancelled

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

status

required

string

Allowed values: cancelled

Example

{
  "data": {
    "status": "cancelled"
  }
}

401

Dashboard authentication required

409

Takeover already ended