installPlugin

POST

/api/v1/plugins/{pluginId}/install

const url = 'https://example.com/api/v1/plugins/example/install';
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/plugins/example/install \
  --cookie tilecast_session=<tilecast_session>

Requires the Owner or Administrator role and an authenticated user with the admin scope. Cookie requests also require CSRF. Records a release-owned plugin as installed. Idempotent. Never downloads or runs code.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

pluginId

required

string

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

Registry identifier such as countdown_bar.

Header Parameters

X-CSRF-Token

string

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

Responses

200

Plugin was already installed; same representation

application/json

object

data

required

object

required

string

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

version

required

Definition contract version compiled into this release

integer

>= 1

name

required

string

description

required

string

category

required

string

Allowed values: Display Automation Workflow Hardware

icon

required

Bounded icon identifier; unknown values render a generic icon

string

managementPath

required

Studio route; a navigation hint, not an authorization boundary

string

instanceNounSingular

required

string

instanceNounPlural

required

string

requirements

required

Array<object>

object

kind

required

string

Allowed values: platform hardware region network provider player

label

required

string

description

string

capabilities

required

Array<string>

documentation

string

installed

required

boolean

installable

required

boolean

configured

required

boolean

active

required

boolean

instanceCount

required

integer

attention

required

Array<object>

object

code

required

string

message

required

string

Example

{
  "data": {
    "category": "Display",
    "requirements": [
      {
        "kind": "platform"
      }
    ],
    "attention": [
      {
        "code": "no_compatible_player"
      }
    ]
  }
}

201

Plugin installed by this request

application/json

object

data

required

object

required

string

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

version

required

Definition contract version compiled into this release

integer

>= 1

name

required

string

description

required

string

category

required

string

Allowed values: Display Automation Workflow Hardware

icon

required

Bounded icon identifier; unknown values render a generic icon

string

managementPath

required

Studio route; a navigation hint, not an authorization boundary

string

instanceNounSingular

required

string

instanceNounPlural

required

string

requirements

required

Array<object>

object

kind

required

string

Allowed values: platform hardware region network provider player

label

required

string

description

string

capabilities

required

Array<string>

documentation

string

installed

required

boolean

installable

required

boolean

configured

required

boolean

active

required

boolean

instanceCount

required

integer

attention

required

Array<object>

object

code

required

string

message

required

string

Example

{
  "data": {
    "category": "Display",
    "requirements": [
      {
        "kind": "platform"
      }
    ],
    "attention": [
      {
        "code": "no_compatible_player"
      }
    ]
  }
}

403

Owner or Administrator and CSRF token required

404

Plugin_not_found — the release does not define this plugin

409

Plugin_not_installable