Documentation menu

List cron jobs

GEThttps://api.instacloud.com/projects/{projectId}/cron-jobs

Token scope: account · org · project — read-only tokens allowed.

List the project’s cron jobs, optionally for one branch.

Parameters

NameInTypeRequiredDescription
branchquerystringnobranch name; omitted lists every branch
projectIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
jobsobject[]yes
jobs.idstringyes
jobs.project_idstringyes
jobs.branch_idstringyes
jobs.branchstringyesbranch name, joined for readability — the id is the identity
jobs.namestringyes
jobs.expressionstringyes
jobs.timezonestringyesUTC in v1, so preview and the materializer can never disagree
jobs.enabledbooleanyes
jobs.revisionintegeryesthe If-Match guard for PATCH
jobs.next_run_atstring | nullyes
jobs.targetobjectyesWhere the job sends its request. An internal target names the SERVICE, never a URL: the worker resolves the live route at send time, so a redeploy or a region move cannot leave a job firing at a dead host.
jobs.requestobjectyesThe non-secret description of the job’s request.
jobs.request.method"GET" | "POST"yes
jobs.request.headerNamesstring[]yesnames only, literal and secret-backed alike — never values
jobs.request.secretRefsobjectyesheader name → secret NAME for the secret-backed headers. Names are not credentials, so they are returned: an edit can re-send these as they are, where a literal header’s value must be supplied again.
jobs.request_timeout_msintegeryes
jobs.retry_policyobjectyes
jobs.retry_policy.platformMaxRetriesintegernoretries for failures where nothing was sent (wake/transport). Default 2.
jobs.retry_policy.applicationMaxRetriesintegernoretries for a non-2xx answer. Default 0 — a broken endpoint should not be hammered.
jobs.retry_policy.retryableStatusesinteger[]noe.g. [429, 503]; empty means none
jobs.retry_policy.maxRunAgeMsintegernogive up on the run once it is this old, whatever the retry budget says
jobs.created_atstringyes
jobs.updated_atstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown