API endpoints for managing Kubiya runners that execute tools
Method | Path | Description |
---|---|---|
GET | /api/v3/runners | List all runners |
GET | /api/v3/runners/{runner}/describe | Get runner details |
GET | /api/v3/runners/{runner}/health | Get runner health |
DELETE | /api/v3/runners/{runner} | Delete a runner |
PUT | /api/v3/runners/description/{runner} | Update runner description |
POST | /api/v3/runners/{runner} | Create a new runner with a specific name |
GET | /api/v3/runners/helmchart/{runner} | Get Helm chart for a runner |
GET | /api/v3/runners/helm/{runner} | Get Helm YAML for a runner |
POST | /api/v3/runners/{runner}/ops | Perform operations on a runner |
Status Code | Description |
---|---|
200 | Success |
400 | Bad Request - Invalid parameters or request body |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource doesn’t exist |
500 | Internal Server Error |
HTTP Status | Description |
---|---|
400 | Bad Request - Invalid request body or missing required fields |
401 | Unauthorized - API key is missing or invalid |
403 | Forbidden - The API key doesn’t have permission to perform this action |
404 | Not Found - The specified runner was not found |
500 | Internal Server Error - An unexpected error occurred on the server |