GET /runner_instance
Lists all runner instances for the authenticated organization with optional filtering and pagination. You can filter by labels, status, creation date, job ID, and search across multiple fields.
In: header
Query Parameters
Filter by labels
Filter by job ID
Filter by creation date (format: >2023-01-01T00:00:00Z or 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)
Filter by status (e.g., init_triggered, init_complete, polling, suspending, suspended, allocating, allocated, running, completed, purging, purged)
Filter by stack ids
Search string to filter runner instances (searches across id, status, labels, provider alias, and job_id with exact match)
Include internal cloud runners in the results
Page number (default: 1)
Number of items per page (default: 20)
Response Body
application/json
application/json
application/json
curl -X GET "https://api.warpbuild.com/api/v1/runner_instance"{
"next_page": 0,
"page": 0,
"per_page": 0,
"runner_instances": [
{
"allocated_at": "string",
"allocation_for": "string",
"allocation_mutex_timeout": "string",
"allocation_path": "string",
"allocation_requested_at": "string",
"allocation_requested_event_at": "string",
"cluster": "string",
"configuration": {
"byoc_sku": {
"arch": "x64",
"imdsv2_required": true,
"instance_types": [
"m5.xlarge",
"m5.2xlarge"
],
"is_public": false,
"network_tier": "STANDARD",
"role_arn": "arn:aws:iam::123456789012:role/WarpBuildRole"
},
"capacity_type": "spot",
"image": "string",
"sku": {
"arch": "x64",
"cores": 0,
"display_name": "string",
"id": "string",
"memory": 0,
"os": [
"mac"
],
"properties": {
"burstable_speed": 0,
"generation": "string",
"gpu": 0,
"manufacturer": "any",
"performance_category": "small",
"performance_rating": 0,
"speed": 0
}
},
"stock_runner_set_id": "string",
"storage": {
"disk_type": "pd-balanced",
"iops": 0,
"performance_tier": "P15",
"size": 0,
"throughput": 0,
"tier": "low"
}
},
"created_at": "string",
"created_by": "string",
"dynamic_overrides": {
"configuration_overrides": {
"byoc_sku": {
"arch": "x64",
"imdsv2_required": true,
"instance_types": [
"m5.xlarge",
"m5.2xlarge"
],
"is_public": false,
"network_tier": "STANDARD",
"role_arn": "arn:aws:iam::123456789012:role/WarpBuildRole"
},
"capacity_type": "spot",
"image": "string",
"sku": {
"arch": "x64",
"cores": 0,
"display_name": "string",
"id": "string",
"memory": 0,
"os": [
"mac"
],
"properties": {
"burstable_speed": 0,
"generation": "string",
"gpu": 0,
"manufacturer": "any",
"performance_category": "small",
"performance_rating": 0,
"speed": 0
}
},
"stock_runner_set_id": "string",
"storage": {
"disk_type": "pd-balanced",
"iops": 0,
"performance_tier": "P15",
"size": 0,
"throughput": 0,
"tier": "low"
}
},
"hardware_features": {
"property1": true,
"property2": true
},
"network_addon_config_id": "string",
"snapshot_enabled": true,
"snapshot_key": "string"
},
"external_id": "string",
"first_polled_at": "string",
"host": "string",
"id": "string",
"label_attributes": {
"attributes_arr": [
{
"attributes": {},
"runner": "string"
}
],
"parsed_labels": [
"string"
]
},
"labels": [
"string"
],
"last_job_processed_id": "string",
"last_job_processed_meta": {
"vcs_base_ref": "string",
"vcs_default_branch": "string",
"vcs_end_time": "string",
"vcs_head_ref": "string",
"vcs_job_name": "string",
"vcs_org": "string",
"vcs_ref": "string",
"vcs_ref_type": "string",
"vcs_repo": "string",
"vcs_start_time": "string",
"vcs_workflow_group_id": "string"
},
"last_polled_at": "string",
"organization_id": "string",
"post_resume_first_polled_at": "string",
"provider_kind_id": "string",
"purged_at": "string",
"purged_reason": "string",
"runner_for": "string",
"runner_set_id": "string",
"running_started_at": "string",
"stack_kind": "string",
"status": "string",
"suspended_at": "string",
"suspending_started_at": "string",
"updated_at": "string",
"vcs_integration_id": "string"
}
],
"total_items": 0,
"total_pages": 0
}{
"code": "string",
"description": "string",
"message": "string",
"sub_code": "string",
"sub_message": "string"
}{
"code": "string",
"description": "string",
"message": "string",
"sub_code": "string",
"sub_message": "string"
}GET /runners/usage
Retrieves usage statistics for runners within a specified date range. Returns aggregated data about runner execution times, job counts, and resource consumption for billing and monitoring purposes.
GET /runner_pool
Lists all runner pools for the authenticated organization. Runner pools allow you to configure warm pools of pre-provisioned runner instances for faster job startup times. A pool maintains a specified number of idle runner instances ready to be allocated immediately when a job is queued.