List all runs

GET

/api/runs

const url = 'http://localhost:9477/api/runs?limit=50&offset=0&triggeredBy=cron&sortField=taskName&sortDirection=asc';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:9477/api/runs?limit=50&offset=0&triggeredBy=cron&sortField=taskName&sortDirection=asc'

Parameters

Query Parameters

limit

Max results per page

integer format: int64

default: 50 >= 1 <= 1000

Max results per page

offset

Pagination offset

integer format: int64

Pagination offset

status

Comma-separated run statuses (phase or end reason); a run matches any listed value

string

Comma-separated run statuses (phase or end reason); a run matches any listed value

taskName

Filter by task name

string

Filter by task name

triggeredBy

Filter by what triggered the run

string

Allowed values: cron api cloud service startup ""

Filter by what triggered the run

createdAfter

Only runs created at or after this RFC3339 time

string format: date-time

Only runs created at or after this RFC3339 time

createdBefore

Only runs created at or before this RFC3339 time

string format: date-time

Only runs created at or before this RFC3339 time

exitCodeMin

Only runs whose exit code is >= this (inclusive)

string

/^-?[0-9]+$/

Only runs whose exit code is >= this (inclusive)

exitCodeMax

Only runs whose exit code is <= this (inclusive)

string

/^-?[0-9]+$/

Only runs whose exit code is <= this (inclusive)

retriesOnly

Only runs that are a retry (retry_attempt > 0)

boolean

Only runs that are a retry (retry_attempt > 0)

sortField

Field to sort by

string

Allowed values: taskName status startAt exitCode duration createdAt ""

Field to sort by

sortDirection

Sort direction

string

Allowed values: asc desc ""

Sort direction

search

Search query

string

Search query

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

runs

required

List of runs

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

createdAt

required

string format: date-time

endAt

string format: date-time

endReason

Why a run ended. Set when status=ended.

string

Allowed values: success failed stopped timeout crashed skipped log_overflow queue_full dst_skipped daemon_stopped missed start_failed

exitCode

required

integer format: int64

externalExecutionId

string

required

string

instanceIndex

required

integer format: int64

params

object

key

additional properties

string

retryAttempt

required

integer format: int64

retryOfRunId

string

startAt

string format: date-time

status

required

Run lifecycle phase

string

Allowed values: pending running ended

taskName

required

string

triggeredBy

required

How the run was triggered

string

Allowed values: cron api cloud service startup

total

required

Total matching runs

integer format: int64

Example

{
  "$schema": "http://localhost:9477/schemas/RunsResponseBody.json",
  "runs": [
    {
      "$schema": "http://localhost:9477/schemas/Run.json",
      "endReason": "success",
      "status": "pending",
      "triggeredBy": "cron"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}