Skip to content
Tilecast Docs

listPluginStore

GET
/api/v1/plugin-store
curl --request GET \
  --url https://example.com/api/v1/plugin-store \
  --cookie tilecast_session=<tilecast_session>

The normalized plugin store. Every plugin source Studio can browse, joined with this installation’s state. Readable by any signed-in account. Release-owned entries always appear; marketplace entries join the release-owned entries; custom entries join from bound repositories.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Plugin store

Media typeapplication/json
object
data
required
object
items
required
Array<object>

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
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, 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

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

The cached catalog behind marketplace entries. Fetch failures keep serving the last valid cache and record the error here.

object
lastFetchedAt
string format: date-time
stale
required
boolean
error
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": [
      {
        "plugin": {
          "category": "Display",
          "requirements": [
            {
              "kind": "platform"
            }
          ],
          "attention": [
            {
              "code": "no_compatible_player"
            }
          ]
        }
      }
    ]
  }
}

401

Section titled “401”

Dashboard authentication required