revokeScreenCredential

POST

/api/v1/screens/{id}/revoke

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke';
const options = {
  method: 'POST',
  headers: {
    cookie: 'tilecast_session=<tilecast_session>',
    'Content-Type': 'application/json'
  },
  body: '{"reason":"example"}'
};

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/revoke \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "reason": "example" }'

Requires the Owner or Administrator role with the admin scope. Cookie requests additionally require the X-CSRF-Token header. Permanently revokes a screen’s device credential.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

object

reason

string

<= 1000 characters

Example^generated

{
  "reason": "example"
}

Responses

204

Credential permanently revoked

401

Dashboard authentication required

403

Owner or Administrator required