Delete a secret

client.secretsStore.stores.secrets.delete(, , ?): SecretDeleteResponse | null

DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Deletes a single secret.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Secrets Store Write

ParametersExpand Collapse

secretID: string

maxLength32

params: SecretDeleteParams { account_id, store_id }

account_id: string

Account identifier.

maxLength32

store_id: string

Store identifier.

maxLength32

ReturnsExpand Collapse

SecretDeleteResponse = unknown

Result is null for delete operations.

Delete a secret

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const secret = await client.secretsStore.stores.secrets.delete('3fd85f74b32742f1bff64a85009dda07', {
  account_id: '985e105f4ecef8ad9ca31a8372d0c353',
  store_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(secret);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {}
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {}
}