ReferenceHTTP APIVariables

Create or replace an agent's own variable

PUT
/v1/agents/{id}/variables/{name}

Owners, admins and that agent's admins, signed in as a person; never an API key. Preconditions, limits and receipt as for the workspace's variables; an agent holds 50. The agent's value wins over a workspace value of the same name.

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 agent's id.

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
name*string

The variable's name.

Length1 <= length

Header Parameters

If-Match?string

The version last read, as a number (an entity tag's quotes are allowed). A different one answers 412 VERSION_MISMATCH; none answers 428 PRECONDITION_REQUIRED. Send it to change a variable that exists, If-None-Match: * to create one; never both.

Length1 <= length
If-None-Match?"*"

The literal *, to create a variable that must not exist yet. One that exists answers 412 VERSION_MISMATCH.

Value in"*"
X-Requested-With?"werft-web"

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

Value in"werft-web"

Request Body

application/json
  1. body
kind*string
Value in"plain""secret"
value*string
engine_delivery?boolean
acknowledge_engine_exposure?boolean
allow_automation?boolean

Response Body

The variable's new version and its grant_version.

application/json
  1. response
name*string
Match^[A-Z][A-Z0-9_]{0,63}$
version*integer
Range0 < value <= 9007199254740991
grant_version*integer
Range0 < value <= 9007199254740991
Example Request
curl -X PUT 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/variables/string' \  -H 'Content-Type: application/json' \  -d '{  "kind": "plain",  "value": "ap-northeast-1"}'
Example Response
{  "name": "REGION",  "version": 44,  "grant_version": 42}