레퍼런스HTTP APIAgents

Retry one agent of a profile rollout

POST
/v1/installation-profiles/{profile_id}/rollout/retry

The operator (profile.installation.manage, the workspace owner), signed in. A new version of a profile moves the agents that follow it onto the version; one the move failed for stays on its release, with the reason in installation.rollout.failed_agents of GET /v1/profiles and in profile_rollout of the agent. A failed agent is never tried again by itself; this call is the one way to do it. The agent is judged afresh: its current release, whether it still follows, and the profile's newest version. retried: false when none of its steps for this version was failed (retried already, say).

Auth: cookie session only; no scope. Idempotency-Key: ignored.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

profile_id*string

The installation profile's id.

Length1 <= length <= 200

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
agent_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Whether a failed step was put back to wait.

application/json
  1. response
retried*boolean
Example Request
curl -X POST 'https://example.com/v1/installation-profiles/string/rollout/retry' \  -H 'Content-Type: application/json' \  -d '{  "agent_id": "019a0000-0000-7000-8000-0000000000a1"}'
Example Response
{  "retried": true}