ESescape
VaultVariables

Update a vault variable

Replace the value of a plaintext or secret variable, or the entry name of an external variable. The name and the type stay as they are. The new value is write-only.

put/vault-variables/{variableId}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

variableIdstring uuid required

The ID of the vault variable

Example:00000000-0000-0000-0000-000000000000

Request body

valuestring

The new plaintext or secret value. Write-only. Forbidden for an EXTERNAL variable.

externalEntrystring

The new entry name inside the provider vault. Only for an EXTERNAL variable.

Response

OK

idstring uuid required

The id of the vault variable

type'EXTERNAL' | 'PLAINTEXT' | 'SECRET' required

The type of the vault variable

namestring required

The name of the vault variable, referenced from scan configs as ${NAME}

Changes

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