API reference | GetRatchet

GET/api/v1/runs

List recent runs

READRead only

Authentication

Send Authorization: Bearer using a key with scope READ. Create a temporary key in Try it.

Parameters

qquery · stringOptional

Run name or ID substring

runIdquery · stringOptional

Exact run ID

projectIdquery · stringOptional

Exact project ID

environmentIdquery · stringOptional

Exact environment ID

statusquery · string · RUNNING | SUCCEEDED | FAILEDOptional

Run status

isTestquery · string · true | falseOptional

Filter synthetic test runs

servicequery · stringOptional

Service name substring

toolquery · stringOptional

Tool name substring

handlerVersionquery · stringOptional

Exact handler version

idempotencyKeyquery · stringOptional

Exact step idempotency key

fromquery · stringOptional

Inclusive ISO date or timestamp

toquery · stringOptional

Inclusive ISO date or timestamp

cursorquery · stringOptional

Last run ID from the previous page

limitquery · integerOptional

Page size; default 25

Example request

Examples use the values from Try it. The key is read from an environment variable.

curl --request GET 'https://getratchet.app/api/v1/runs' \
  --header "Authorization: Bearer $GETRATCHET_API_KEY"

const response = await fetch("https://getratchet.app/api/v1/runs", {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.GETRATCHET_API_KEY}` },
});
console.log(response.status, await response.text());

import os, urllib.request, urllib.error

request = urllib.request.Request(
    "https://getratchet.app/api/v1/runs", method='GET',
    headers={'Authorization': 'Bearer ' + os.environ['GETRATCHET_API_KEY']},
)
try:
    with urllib.request.urlopen(request) as response:
        print(response.status, response.read().decode())
except urllib.error.HTTPError as error:
    print(error.code, error.read().decode())

No request body

Illustrative examples with representative fields. Actual IDs and results depend on your data.

200 · Success

{
  "runs": [],
  "nextCursor": null
}

AuthenticationNot signed in

Bearer API key

Key stays in memory in this tab. This operation requires READ.

Your actual response will appear here after sending.

const response = await fetch("https://getratchet.app/api/v1/runs", { method: 'GET', headers: { Authorization: `Bearer ${process.env.GETRATCHET_API_KEY}` }, }); console.log(response.status, await response.text());

import os, urllib.request, urllib.error request = urllib.request.Request( "https://getratchet.app/api/v1/runs", method='GET', headers={'Authorization': 'Bearer ' + os.environ['GETRATCHET_API_KEY']}, ) try: with urllib.request.urlopen(request) as response: print(response.status, response.read().decode()) except urllib.error.HTTPError as error: print(error.code, error.read().decode())