Skip to main content
DELETE
Schedule deletion (soft delete with recovery window)
Requires the IAM action secrets:DeleteSecret. See SECRETS permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

secret_id
string<uuid>
required
Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json
recovery_window_days
integer

Override the secret's stored window. Omit to keep it.

Required range: 1 <= x <= 30
Example:

14

Response

Secret scheduled for purge.

secret
object
required