リファレンスHTTP APIAgents

Retire an installation ceiling

POST
/v1/installation-profiles/{profile_id}/retire

The operator (profile.installation.manage, the workspace owner), signed in. Any ceiling, imported or saved in the console. A retired ceiling takes no new release, no session without a release and no new workspace profile over it, and a workspace profile over it reads base_retired; releases already made on either, and their sessions, keep running. Retiring one already retired changes nothing and answers a null receipt_id; otherwise writes a retire_installation_profile receipt.

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"

Response Body

The ceiling as retired.

application/json
  1. response
profile*
receipt_id*|null
Example Request
curl -X POST 'https://example.com/v1/installation-profiles/string/retire'
Example Response
{  "profile": {    "id": "op_coding_v2",    "source": "operator",    "model": "claude-sonnet-5",    "models": [      "claude-sonnet-5",      "claude-haiku-5"    ],    "tools": [      "Read",      "Edit",      "Write",      "Glob",      "Grep",      "Bash"    ],    "permission_mode": "acceptEdits",    "runtime_kind": "claude_agent_sdk",    "runtime_version": "0.3.319",    "billing": "metered",    "repository_mode": "required",    "repository_ids": [      "sample-app"    ],    "installation": {      "name": "coding",      "version": 2,      "origin": "console",      "state": "retired",      "connection_id": "anthropic-main",      "title_model": "claude-haiku-5",      "project_settings": {        "claude_md": true      },      "previous_id": "op_coding_v1",      "created_by": "019a0000-0000-7000-8000-0000000000b1",      "created_at": "2026-10-28T01:00:00.000Z",      "retired_by": "019a0000-0000-7000-8000-0000000000b1",      "retired_at": "2026-10-28T02:00:00.000Z",      "blocked_by": null,      "blocked_at": null    }  },  "receipt_id": "019a0000-0000-7000-8000-0000000000e4"}