Get a single run by ID

GET

/api/runs/{runId}

const url = 'http://localhost:9477/api/runs/example';
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/example

Parameters

Path Parameters

runId

required

Run ULID

string

>= 26 characters <= 26 characters /^[0-9A-HJKMNP-TV-Z]{26}$/

Run ULID

Responses

200

application/json

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

Example

{
  "$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"
}