Runners API
API endpoints for managing Kubiya runners that execute tools
Runners API
Runners in Kubiya are the execution environments that run tools and provide capabilities to teammates. The Runners API allows you to create, manage, and monitor runner instances in your environment.
This playground makes API calls to Kubiya API through a secure server-side proxy. Your requests never expose your API token directly to the browser.
Endpoints
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 |
List Runners
Retrieve all runners in your organization.
Headers
Name | Required | Description |
---|---|---|
Authorization | Yes | UserKey YOUR_API_KEY |
Response
Get Runner Health
Check the health status of a runner and its components.
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
runnerName | string | Yes | Name of the runner |
Headers
Name | Required | Description |
---|---|---|
Authorization | Yes | UserKey YOUR_API_KEY |
Response
Create Runner
Create a new runner instance.
Headers
Name | Required | Description |
---|---|---|
Authorization | Yes | UserKey YOUR_API_KEY |
Content-Type | Yes | application/json |
Request Body
Response
Example Usage
Runners are essential components of the Kubiya platform. Make sure to monitor their health and ensure they have the necessary permissions to execute tools.
Common Errors
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 |
Next Steps
After setting up runners, you can:
- Use them to load sources with specific tools
- Configure teammates to use tools that the runners execute
- Manage runners using Terraform
Endpoint Descriptions
- GET
/api/v3/runners
: Retrieve a list of all runners in your organization. - GET
/api/v3/runners/{runner}/describe
: Get detailed information about a specific runner. - GET
/api/v3/runners/{runner}/health
: Check the health status of a runner and its components. - DELETE
/api/v3/runners/{runner}
: Delete a specific runner from your organization. - PUT
/api/v3/runners/description/{runner}
: Update the description of a runner. - POST
/api/v3/runners/{runner}
: Create a new runner with a specific name and configuration. - GET
/api/v3/runners/helmchart/{runner}
: Retrieve the Helm chart for deploying a runner. - GET
/api/v3/runners/helm/{runner}
: Retrieve the Helm YAML manifest for a runner. - POST
/api/v3/runners/{runner}/ops
: Perform operations (such as restart) on a runner.