tool-settings

Clear Sandbox Credential

Changed on

Delete the stored sandbox key, so sandboxes are leased with the environment's key again.

Clearing a key that was never stored is not an error. Operator-gated.

delete/api/v1/tool-settings/sandbox/credential

Request

  • The document declares no server URL.
  • Auth
    • API key in header Otari-Key
    • or API key in header x-api-key

Response

Successful Response

env_varstring required

The environment variable a deployment that stores no key is read from.

last4string nullable

The key's last four characters, to tell keys apart.

source'stored' | 'environment' nullable required

'stored' for a key set here, which wins; 'environment' for the provider's own environment variable; null when there is neither and code execution fails until one is set.

Changes