Read a run and its evidence

GET

/v1/runs/{run}

curl --request GET \
  --url 'https://api.proxymail.qa/v1/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?format=json' \
  --header 'Authorization: Bearer <token>'

As JSON, or with format=markdown the report for a pull request comment or a job summary. Both compare it with the last 10 finished runs of the same name (comparison in JSON: how many runs, and a list of changes, each a kind and its text in parts).

Authorizations

• apiKey

Parameters

Path Parameters

run

required

string format: uuid

Query Parameters

format

string

default: json

Allowed values: json markdown

Responses

200

The run

object

id

string format: uuid

name

string

source

string

Allowed values: ci agent api

status

string

Allowed values: running passed failed

meta

object

started_at

string format: date-time

finished_at

string | null format: date-time

url

The run in the app.

string format: uri

project

object

id

string

name

string

events

What the run saw, oldest first. Not in lists.

Array<object>

object

at

string format: date-time

kind

string

Allowed values: address email missing none count checks note checkout

address

string | null

failed

boolean

detail

Email: type, subtype, service, received_at, after_seconds, and code or link and goes_to ({ site, path }). missing: what was waited for and hint. none: arrived, since, until. count: count. checks: passed, failed, warnings and notes. note: text.

object

Example

{
  "source": "ci",
  "status": "running",
  "events": [
    {
      "kind": "address"
    }
  ]
}

string

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}