Retry Pipeline — POST /api/v1/agents/pipelines/{pipeline_id}/retry
Retry Pipeline
Retry a finished-but-unsuccessful pipeline run.
Endpoint: POST /api/v1/agents/pipelines/{pipeline_id}/retry
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA engineer or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
pipeline_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
202 | Successful Response | Not documented (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.
Errors this endpoint returns, read from its source code:
404, with the message “TestRun not found for this pipeline”409, with messages such as “Another pipeline for this run is already in progress”, “Pipeline finished successfully; nothing to retry”, “Pipeline is still in progress”, and 2 other messages
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Agents
- Operation ID:
retry_pipeline_api_v1_agents_pipelines__pipeline_id__retry_post - Source code:
backend/app/routers/agents.py, line 526 - Specification: OpenAPI JSON