リファレンスHTTP APIAgents

Move a connection's key from the deployment to a stored value

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

The operator (installation.settings.manage, the workspace owner), signed in; an API key is 403 whatever its scopes. For a connection whose key comes from the operator's deployment (an env or Secrets Manager reference): the person types the key, it is sealed under the same id, and the row is stored from then on. The server does not read the referenced value. Ceilings made before keep running on the stored key and their pins do not change. A settings document that still names the old entry leaves the row as it is. A connection that already keeps its own value is 409 not_external, a disabled one 409 disabled, one that another connection is or was exactly 409 alias_taken, the secret store off 503. Writes a set_settings_credential receipt naming the last four characters and which reference it replaced.

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/convert' \  -H 'Content-Type: application/json' \  -d '{  "value": "example-key"}'
Example Response
{  "id": "anthropic-main",  "receipt_id": "019a0000-0000-7000-8000-0000000000f3"}