disableScreen

POST

/api/v1/screens/{id}/disable

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/disable';
const options = {method: 'POST', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

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/disable \
  --cookie tilecast_session=<tilecast_session>

Requires the Owner or Administrator role with the write scope. Cookie requests additionally require the X-CSRF-Token header. Disables a screen and disconnects its player.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

required

string format: uuid

Responses

204

Screen disabled and disconnected