LogoCloudflare API

Secrets Store

secrets_store

Secrets Store

Quota

secrets_store.quota

Methods

View Secret Usage -> Envelope<{ secrets }>
get/accounts/{account_id}/secrets_store/quota

Lists the number of secrets used in the account.

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 Secrets Store Read

path Parameters
account_id: string
(maxLength: 32)

Account Identifier

Response fields
errors: Array<{ code, message, documentation_url, 1 more... }>
messages: Array<{ code, message, documentation_url, 1 more... }>
success: true

Whether the API call was successful.

result: { secrets }
Optional
result_info: { count, page, per_page, 1 more... }
Optional
Request example
200Example
Secrets Store

Stores

secrets_store.stores

Methods

List Account Stores -> V4PagePaginationArray<{ id, created, modified, 1 more... }>
get/accounts/{account_id}/secrets_store/stores

Lists all the stores in an account

Create A Store -> SinglePage<{ id, created, modified, 1 more... }>
post/accounts/{account_id}/secrets_store/stores

Creates a store in the account

Delete A Store -> Envelope<{ id, created, modified, 1 more... }>
delete/accounts/{account_id}/secrets_store/stores/{store_id}

Deletes a single store

Secrets StoreStores

Secrets

secrets_store.stores.secrets

Methods

List Store Secrets -> V4PagePaginationArray<{ id, created, modified, 4 more... }>
get/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Lists all store secrets

Get A Secret By ID -> Envelope<{ id, created, modified, 4 more... }>
get/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Returns details of a single secret

Create A Secret -> SinglePage<{ id, created, modified, 4 more... }>
post/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Creates a secret in the account

Patch A Secret -> Envelope<{ id, created, modified, 4 more... }>
patch/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Updates a single secret

Delete A Secret -> Envelope<{ id, created, modified, 4 more... }>
delete/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Deletes a single secret

Delete Secrets -> SinglePage<{ id, created, modified, 4 more... }>
delete/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Deletes one or more secrets

Duplicate Secret -> Envelope<{ id, created, modified, 4 more... }>
post/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate

Duplicates the secret, keeping the value