Skip to content
Tilecast Docs

listPlugins

GET
/api/v1/plugins
curl --request GET \
  --url https://example.com/api/v1/plugins

Every plugin the running release offers, joined with this installation’s state. Readable by any signed-in account.

Responses

Section titled “ Responses ”

200

Section titled “200”

Plugin catalog

Media typeapplication/json
object
data
required
object
items
required
Array<object>
object
id
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

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
unsupportedInstallations
required

Installation rows naming plugins this release does not know. Preserved and inert.

Array<object>
object
pluginId
required
string
installedAt
required
string format: date-time
Example
{
  "data": {
    "items": [
      {
        "category": "Display",
        "requirements": [
          {
            "kind": "platform"
          }
        ],
        "attention": [
          {
            "code": "no_compatible_player"
          }
        ]
      }
    ]
  }
}