Trigger a job run

POST

https://api.islo.dev/jobs/:name/runs

POST

/jobs/:name/runs

$ curl -X POST https://api.islo.dev/jobs/name/runs \
>      -H "Authorization: Bearer <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "string",
3   "job_name": "string",
4   "job_version_id": "string",
5   "status": "string",
6   "region": "string",
7   "run_params": {},
8   "result_payload": {},
9   "step_timeline": [
10     {
11       "name": "string",
12       "action": "string",
13       "status": "string",
14       "task_name": "string",
15       "sandbox_name": "string",
16       "agent_session_id": "string",
17       "started_at": "2024-01-15T09:30:00Z",
18       "completed_at": "2024-01-15T09:30:00Z",
19       "error_message": "string",
20       "error_code": "string",
21       "error_details": {},
22       "compute_command_id": "string"
23     }
24   ],
25   "artifact_refs": [
26     {
27       "type": "string",
28       "provider": "string",
29       "external_ref": {
30         "provider": "string",
31         "kind": "string",
32         "owner": "string",
33         "repo": "string",
34         "number": 1,
35         "node_id": "string",
36         "id": "string"
37       },
38       "operation": "string",
39       "url": "string",
40       "title": "string",
41       "status": "string",
42       "metadata": {}
43     }
44   ],
45   "started_at": "2024-01-15T09:30:00Z",
46   "completed_at": "2024-01-15T09:30:00Z",
47   "error_message": "string",
48   "created_at": "2024-01-15T09:30:00Z",
49   "error_code": "string",
50   "error_details": {}
51 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

namestringRequired

Request

This endpoint expects an object.

version_idstring or nullOptionalformat: "uuid"

Deployed version to run; defaults to latest

regionstring or nullOptional

Compute region override

paramsmap from strings to anyOptional

Run-time parameter values (validated against [job.params])

Response

Successful Response

idstringformat: "uuid"

job_namestring

job_version_idstringformat: "uuid"

statusstring

regionstring or null

run_paramsmap from strings to any

result_payloadmap from strings to any or null

step_timelinelist of objects

artifact_refslist of objects

started_atdatetime or null

completed_atdatetime or null

error_messagestring or null

created_atdatetime

error_codestring or nullOptional

error_detailsmap from strings to any or nullOptional

Errors

422

Unprocessable Entity Error