getPluginStoreEntry

GET

/api/v1/plugin-store/{packageId}

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

One normalized plugin-store entry. Readable by any signed-in account. Unknown package IDs answer plugin_not_found.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

packageId

required

string

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

Store package identifier such as countdown_bar.

Responses

200

Plugin store entry

application/json

object

data

required

One normalized plugin-store row. The package identity and provenance every source shares, plus the source-owned detail. Exactly one of plugin, marketplace, and custom is present. An included plugin also carries its presentation in included.

object

packageId

required

string

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

source

required

Where a store entry comes from. “included” entries are compiled into the release; “marketplace” entries come from the official catalog and carry its catalog ID; “custom” entries come from a bound repository and carry its URL. Clients must tolerate values they do not know.

object

kind

required

string

catalogId

string

repository

string

plugin

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

marketplace

One marketplace listing joined with this installation’s state. Exactly one of plugin, marketplace, and custom is present on a store entry.

object

version

required

string

name

required

string

description

string

longDescription

Optional plain text for the listing page. Presentation only: it never affects identity, digest, trust, or install. Studio falls back to description when absent.

string

<= 2000 characters

publisherId

required

string

publisherName

required

string

license

string

tilecastRange

required

string

digest

required

Pinned artifact digest as sha256 colon hex.

string

repository

required

Public source repository as a github.com https URL with an owner and name.

string format: uri

documentation

string format: uri

issues

string format: uri

categories

Array<string>

featured

boolean

artwork

Presentation artwork a marketplace listing or an included plugin declares, as Tilecast Server paths. The catalog’s own image addresses never reach Studio. Artwork never affects package identity, trust, or install.

object

iconUrl

Server path that serves the listing icon. Absent when the listing declares no icon.

string

screenshots

Array<object>

object

url

required

Server path that serves the screenshot.

string

alt

required

Text that describes the screenshot.

string

compatible

required

boolean

installed

required

boolean

installedVersion

string

updateAvailable

required

boolean

custom

One custom-repository package joined with this installation’s state. Exactly one of plugin, marketplace, and custom is present on a store entry. Carries no update flag: freshness needs a live re-resolution through an update check.

object

version

required

string

name

required

string

description

string

publisherId

required

string

publisherName

required

string

license

string

tilecastRange

required

string

digest

required

Last verified artifact digest as sha256 colon hex.

string

compatible

required

boolean

installed

required

boolean

installedVersion

string

included

Presentation of an included plugin, from the release’s own Store metadata. It is present only with plugin and never changes identity, installation, capabilities, requirements, trust, or Player manifests.

object

publisherName

required

Who builds the plugin. Included plugins are built by Tilecast.

string

publisherUrl

Optional https address for the publisher.

string

longDescription

Optional plain text for the detail page; never markup.

string

artwork

object

iconUrl

Server path that serves the listing icon. Absent when the listing declares no icon.

string

screenshots

Array<object>

object

url

required

Server path that serves the screenshot.

string

alt

required

Text that describes the screenshot.

string

Example

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

401

Dashboard authentication required

404

Plugin_not_found — no store entry carries this package ID