getPackage

GET

/api/v1/packages/{packageId}

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

One installed extension package. Readable by any signed-in account. Unknown package IDs answer package_not_installed.

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

Installed package

application/json

object

data

required

One installed extension package with its contributions and, for custom packages, the repository binding.

object

packageId

required

string

version

required

string

manifest

required

The human-readable face of an installed or resolved package manifest.

object

name

required

string

description

required

string

publisherId

required

string

publisherName

required

string

license

required

string

tilecastRange

required

string

digest

required

Pinned artifact digest as sha256 colon hex.

string

sourceKind

required

string

sourceReference

required

string

registryReference

required

string

signerIdentity

string

trust

required

string

installedAt

required

string format: date-time

installedBy

required

string | null format: uuid

activatedAt

required

string format: date-time

hasRollback

required

boolean

contributions

required

Array<object>

One activated contribution: its kind, its package-qualified identity, and its path inside the package.

object

kind

required

string

required

string

path

required

string

runtime

External server behavior module (manifest version 2 only).

object

module

required

Package-relative WebAssembly module path.

string

capabilities

Bounded capabilities the package requests. Every entry is a request the host reviews before installation; nothing here grants itself.

object

network

Approved outbound HTTPS origins.

object

hosts

required

Array<string>

background

Package-owned background jobs the host runs.

object

jobs

required

Array<object>

object

required

string

intervalMinutes

required

integer

realtime

One bounded high-frequency background job, separately reviewed.

object

jobs

required

Array<object>

>= 1 items <= 1 items

object

required

string

intervalSeconds

required

integer

>= 5 <= 60

storage

Request plugin-owned key/value storage.

boolean

studioUI

Sandboxed Studio UI entry.

object

entry

required

string

services

Requested Tilecast service grants with registry-resolved display metadata.

Array<object>

object

required

string

version

required

integer

name

required

string

description

required

string

category

required

string

Allowed values: read directory manage audit

operations

required

Array<object>

object

name

required

string

title

required

string

description

required

string

mutating

required

boolean

source

The custom repository binding behind an installed custom package.

object

owner

required

string

name

required

string

repositoryUrl

required

string format: uri

resolvedDigest

required

Last verified artifact digest as sha256 colon hex.

string

resolvedAt

required

string format: date-time

addedAt

required

string format: date-time

Example

{
  "data": {
    "capabilities": {
      "services": [
        {
          "category": "read"
        }
      ]
    }
  }
}

401

Dashboard authentication required

404

Package_not_installed