List Rollouts
List rollouts, optionally within a job, with filters and pagination.
GET
/
rollouts
cURL
curl --request GET \
--url http://127.0.0.1:{port}/rollouts \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.list_rollouts(job_id="JOB_ID", limit=10)
print(result)
client.close()
{
"rollouts": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"state": "queued",
"retry_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phase": "environment_setup",
"task": {
"name": "<string>",
"digest": "<string>",
"source": "<string>"
},
"agent": {
"name": "<string>",
"version": "<string>"
},
"model": {
"name": "<string>",
"provider": "<string>",
"reasoning_effort": "<string>"
},
"rewards": {},
"usage": {
"n_input_tokens": 123,
"n_cached_input_tokens": 123,
"n_output_tokens": 123,
"cost_usd": 123
},
"error_type": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Required only when the server has HARBOR_API_KEY configured.
Headers
Query Parameters
Required range:
1 <= x <= 1000Maximum string length:
4096Task names across versions, or name@sha256: pins. Repeated values use OR.
Maximum array length:
100Required string length:
1 - 4096Available options:
queued, running, paused, cancelling, finished, cancelled Maximum string length:
200Maximum string length:
200Maximum array length:
100Maximum array length:
100Maximum array length:
100Maximum array length:
100Maximum array length:
100Maximum array length:
100Sort field; prefix '-' for descending. Nulls sort last.
Available options:
id, name, state, created_at, updated_at, started_at, finished_at, task_name, agent_name, agent_version, model_name, model_provider, reasoning_effort, source, n_input_tokens, n_cached_input_tokens, n_output_tokens, cost_usd, -id, -name, -state, -created_at, -updated_at, -started_at, -finished_at, -task_name, -agent_name, -agent_version, -model_name, -model_provider, -reasoning_effort, -source, -n_input_tokens, -n_cached_input_tokens, -n_output_tokens, -cost_usd Maximum string length:
100Was this page helpful?
⌘I
cURL
curl --request GET \
--url http://127.0.0.1:{port}/rollouts \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.list_rollouts(job_id="JOB_ID", limit=10)
print(result)
client.close()
{
"rollouts": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"state": "queued",
"retry_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phase": "environment_setup",
"task": {
"name": "<string>",
"digest": "<string>",
"source": "<string>"
},
"agent": {
"name": "<string>",
"version": "<string>"
},
"model": {
"name": "<string>",
"provider": "<string>",
"reasoning_effort": "<string>"
},
"rewards": {},
"usage": {
"n_input_tokens": 123,
"n_cached_input_tokens": 123,
"n_output_tokens": 123,
"cost_usd": 123
},
"error_type": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}