packageJobs

GET

/api/v1/packages/{packageId}/jobs

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

Declared background jobs for one installed package with the scheduler cursor: next run, last outcome, and consecutive failures. Readable by any signed-in account. Unknown packages answer package_not_installed 404.

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

Package background jobs

application/json

object

data

required

Array<object>

One declared package background job with the scheduler cursor.

object

jobId

required

string

intervalMinutes

required

Cadence in minutes. Zero for a realtime job; use intervalSeconds.

integer

intervalSeconds

integer

>= 5 <= 60

kind

string

Allowed values: ordinary realtime

nextRunAt

required

string format: date-time

lastRunAt

string format: date-time

lastStatus

required

string

lastError

required

string

consecutiveFailures

required

integer

Example

{
  "data": [
    {
      "kind": "ordinary"
    }
  ]
}

401

Dashboard authentication required

404

Package_not_installed