Routines

Jobs Bash runs on a schedule in plain words, or whenever your system calls.

Send Authorization: Bearer vk_test_... on every call. Every route of Routines.

GET/v1/routines/{routine_id}/runsPast runs and the tasks they started.

Your API key, scope runtime or all. On the card: routines. Every call here is a checked sample.

Request3 fields

Path

routine_idstringrequiredThe routine's id (rtn_...).

Type: string

Query

limitintegerHow many items per page, 1 to 100. Default 20.

Type: integer

cursorstringWhere to go on from: the next_cursor of the page before, unchanged. Absent: the first page.

Type: string

Answers 2002 fields

dataobject[]The items on this page.

idstringThe run's id.

Type: string

object"routine_run"Always routine_run.

Type: "routine_run"

routine_idstringThe routine it is a run of.

Type: string

conversation_idstring | nullThe conversation the run's message landed in; null when it never got that far.

Type: string | null

status"pending" | "running" | "completed" | "failed" | "skipped"pending or running while it goes. completed: Bash took the ask (the work it started is in task_ids). failed: it could not post the ask. skipped: it did not run, as error says.

Type: "pending" | "running" | "completed" | "failed" | "skipped"

trigger_payloadmap of any | nullThe payload your system sent, for a run on a call; null for a scheduled run.

Type: map of any | null

task_idsstring[]The pieces of work the run started.

Type: string[]

errorstring | nullWhy it failed or was skipped; null otherwise.

Type: string | null

started_atstringWhen it began, as an ISO 8601 date and time in UTC.

Type: string

completed_atstring | nullWhen it ended; null while it goes.

Type: string | null

next_cursorstring | nullSend it as cursor for the next page; null on the last page.

Type: string | null

TypeScript

const runs = await vestra.routines.runs('rtn_5kd');

Python

runs = vestra.routines.runs("rtn_5kd")

CLI

vestra routines runs rtn_5kd

HTTP

curl "$VESTRA_BASE_URL/v1/routines/rtn_5kd/runs" \  -H "Authorization: Bearer $VESTRA_API_KEY"

HTTP

No sample in your language for this route, so here it is over HTTP.

curl "$VESTRA_BASE_URL/v1/routines/rtn_5kd/runs" \  -H "Authorization: Bearer $VESTRA_API_KEY"