cancelPlayerCommand

POST

/api/v1/screens/{id}/commands/{commandId}/cancel

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/commands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel';
const options = {method: 'POST'};

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://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/commands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel

Cancel a pending player command. Requires an Owner or Administrator with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

required

string format: uuid

commandId

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.

Responses

200

Command cancelled

application/json

object

data

required

object

required

string format: uuid

state

required

string

Allowed values: pending delivered acknowledged running succeeded failed cancelled expired

Example

{
  "data": {
    "state": "pending"
  }
}

401

Dashboard authentication required

403

Insufficient role or screen scope

409

Command already completed