ESescape
VaultVariables

Create an external vault variable

Create a variable that points at an entry in a provider vault. Escape looks up the vault and the entry first and rejects the request when either is missing, then links the vault and stores the variable.

post/vault-variables/external

Request

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

Request body

type'EXTERNAL' required
namestring required

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

externalIdstring required

The vault's own coordinate at the provider

externalEntrystring required

The name of the entry inside the provider vault. Write-only.

Example request

{
  "name": "MY_VARIABLE",
  "externalId": "https://my-vault.vault.azure.net/",
  "externalEntry": "production-db"
}

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.