Admin Vault

put/api/v2/admin/vault-values/{storedKey}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/admin/vault-values/{storedKey}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie caplets_dashboard_session

Path parameters

storedKeystring required

Headers

Idempotency-Keystring required

Principal-scoped retry key. Reuse with the same validated request replays the finalized response.

If-Matchstring

Strong ETag required when replacing an existing resource.

If-None-Match'*'

Use * when creating a resource that must not already exist.

X-Caplets-Grant-If-Matchstring

Opaque strong ETag of the current grant named by the request body. Required when that grant exists.

X-Caplets-CSRFstring

Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.

Request body

valuestring required
grantstring
referenceNamestring

Response

Successful direct resource representation.

keystring required
presenttrue required
generationinteger required
valueBytesinteger required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.