getPluginAutomation

GET

/api/v1/plugins/{pluginId}/automation

const url = 'https://example.com/api/v1/plugins/example/automation';
const options = {method: 'GET', 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 GET \
  --url https://example.com/api/v1/plugins/example/automation \
  --cookie tilecast_session=<tilecast_session>

A known, installed plugin’s resolved automation document. Readable by any signed-in account. Operator clients dispatch generic commands on it without naming the plugin. Unknown plugins answer plugin_not_found, known-but-uninstalled ones plugin_not_installed, and plugins with no automation mapping plugin_automation_not_found.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

pluginId

required

string

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

Registry identifier such as countdown_bar.

Responses

200

Resolved automation document

application/json

object

data

required

object

apiVersion

required

integer

Allowed value: 1

plugin

required

string

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

operations

required

Array<object>

object

operationId

required

string

method

required

string

Allowed values: get post put patch delete

path

required

string

risk

required

string

Allowed values: read routine sensitive high-impact security-critical

cliPath

required

Array<string>

mcpAction

required

string

input

string

Allowed values: fields document

description

string

exclusions

required

Array<object>

object

operationId

required

string

reason

required

string

Example

{
  "data": {
    "apiVersion": 1,
    "operations": [
      {
        "method": "get",
        "risk": "read",
        "input": "fields"
      }
    ]
  }
}

401

Dashboard authentication required

404

Plugin_not_found — the release does not define this plugin — or plugin_automation_not_found — it maps no operations into automation

409

Plugin_not_installed