ReferenceHTTP APIAgents

Replace a connection's stored key

POST
/v1/installation/settings/connections/{id}/credential

The operator (installation.settings.manage, the workspace owner), signed in; an API key is 403 whatever its scopes. Seals a new value for a row that stores its own: rotating it or giving a needs_value row its first. Running sessions are not stopped. A row whose credential comes from the operator's deployment is 409 not_stored, a disabled one 409 disabled, the secret store off 503. Writes a set_settings_credential receipt naming the last four characters.

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

id*string

The model connection's id.

Length1 <= length

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
value*string
Length1 <= length <= 8192

Response Body

The entry's id and the change's receipt.

application/json
  1. response
id*string
Length1 <= length
receipt_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
Example Request
curl -X POST 'https://example.com/v1/installation/settings/connections/string/credential' \  -H 'Content-Type: application/json' \  -d '{  "value": "example-key"}'
Example Response
{  "id": "anthropic-console",  "receipt_id": "019a0000-0000-7000-8000-0000000000f3"}