inspectPackagePluginFrame

HEAD

/api/v1/player/packages/{packageId}/plugins/{pluginId}/frame

const url = 'https://example.com/api/v1/player/packages/example/plugins/example/frame';
const options = {method: 'HEAD', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request HEAD \
  --url https://example.com/api/v1/player/packages/example/plugins/example/frame \
  --header 'Authorization: Bearer <token>'

Inspect an installed external plugin frame with a device credential.

Authorizations

deviceBearer

Parameters

Path Parameters

packageId

required

string

/^[a-z][a-z0-9_.:-]{0,127}$/

Store package identifier such as countdown_bar.

pluginId

required

string

/^[a-z][a-z0-9_]{0,79}$/

Responses

200

External plugin frame metadata

401

Device credential invalid or revoked

403

Screen disabled

404

Package or frame unavailable