Get all cron jobs for an environment

GET

/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/cron';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/cron \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

Responses

200

The cron jobs

application/json

Array<object>

object

name

string

description

string

nullable

scheduleExpression

string

command

Array<string>

targetContainerName

string

nullable

isEnabled

boolean

lastRun

The newest run of the job. Null when the job has never run. Sent by the cron list.

object

runId

string

status

FAILED_TO_START: the task could not be launched, so the command never ran (for example, the job targets a container that no longer exists).

string

Allowed values: PENDING RUNNING SUCCEEDED FAILED FAILED_TO_START EXPIRED TIMED_OUT

createdAt

string format: date-time

nullable

exitCode

integer

nullable

errorMessage

Why the run failed, in plain text. Set when the status is FAILED_TO_START.

string

nullable

consecutiveFailures

Failed runs (FAILED or FAILED_TO_START) from the newest run back to the first run that did not fail, counted over the latest 10 runs. 0 when the newest run did not fail. Sent by the cron list.

integer

<= 10

Example

[
  {
    "lastRun": {
      "status": "PENDING"
    },
    "consecutiveFailures": 0
  }
]

404

The environment not found