Runner
List Runner
Endpoint to list all Runner items
post/runner/get-list
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"name": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"key": true,
"connectionStatus": true
},
"sort": {
"createdAt": "DESC"
}
}Response
Successful response
Example response
{
"data": [
{
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "prod-eu-west-1-agent",
"description": "Runs in the production EU cluster; can reach internal services.",
"slug": "example-slug-value",
"key": "Example short text",
"agentVersion": {
"_type": "Version",
"value": "1.0.0"
},
"lastAlive": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"connectionStatus": "connected",
"canRunRunbooks": true,
"canRunAiCommands": true,
"takesCodeFixes": true,
"isGlobalRunner": true,
"isProjectDefault": true,
"hostInfo": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.