Get a cron run

GET

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

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/cron/test-cron/runs/example';
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/test-cron/runs/example \
  --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

cron

required

string

The cron job ID

Example

test-cron

run

required

string

The cron run ID

Responses

200

The cron run

application/json

object

runId

string

runType

string

Allowed values: EXEC CRON

command

string

nullable

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 UNKNOWN

errorMessage

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

string

nullable

startTime

string format: date-time

nullable

endTime

string format: date-time

nullable

exitCode

integer

nullable

output

Array<string>

scheduleName

string

nullable

targetContainerName

string

nullable

Example

{
  "runType": "EXEC",
  "status": "PENDING"
}