List local runners

GET

/v1/private/local-runners

GET

/api/v1/private/local-runners

1 import requests
2 
3 url = "http://localhost:5173/api/v1/private/local-runners"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

1 {
2   "page": 1,
3   "size": 1,
4   "total": 1,
5   "content": [
6     {
7       "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
8       "name": "Local Runner Alpha",
9       "status": "connected",
10       "connected_at": "2024-01-15T09:30:00Z",
11       "agents": [
12         {
13           "name": "Data Processor",
14           "project": "Image Classification",
15           "description": "Processes image data for training",
16           "language": "Python",
17           "executable": "python3",
18           "source_file": "process_images.py",
19           "params": [
20             {
21               "name": "batch_size",
22               "type": "integer"
23             }
24           ],
25           "timeout": 300
26         }
27       ]
28     }
29   ]
30 }

List all local runners in the current workspace

Query parameters

pageintegerOptional>=0Defaults to 0

sizeintegerOptional>=1Defaults to 25

Response

Runners list

pageinteger or null

sizeinteger or null

totallong or null

contentlist of objects or null

Query parameters

Response

Errors