Documentation menu

Get cron job

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

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

Read one cron job. Header values are write-only; request gives the method, the header names, and the secret each secret-backed header names.

Parameters

NameInTypeRequiredDescription
projectIdpathstringyes
idpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
jobobjectyesA cron schedule. Header values are write-only; `request` describes the stored request without them.
job.idstringyes
job.project_idstringyes
job.branch_idstringyes
job.branchstringyesbranch name, joined for readability — the id is the identity
job.namestringyes
job.expressionstringyes
job.timezonestringyesUTC in v1, so preview and the materializer can never disagree
job.enabledbooleanyes
job.revisionintegeryesthe If-Match guard for PATCH
job.next_run_atstring | nullyes
job.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.
job.requestobjectyesThe non-secret description of the job’s request.
job.request.method"GET" | "POST"yes
job.request.headerNamesstring[]yesnames only, literal and secret-backed alike — never values
job.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.
job.request_timeout_msintegeryes
job.retry_policyobjectyes
job.retry_policy.platformMaxRetriesintegernoretries for failures where nothing was sent (wake/transport). Default 2.
job.retry_policy.applicationMaxRetriesintegernoretries for a non-2xx answer. Default 0 — a broken endpoint should not be hammered.
job.retry_policy.retryableStatusesinteger[]noe.g. [429, 503]; empty means none
job.retry_policy.maxRunAgeMsintegernogive up on the run once it is this old, whatever the retry budget says
job.created_atstringyes
job.updated_atstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown