Cloudflare API | Secrets Store › Stores › Secrets › List Store Secrets

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

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.

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 Store Stores

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

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

store_id: string

(maxLength: 32)

Store Identifier

query Parameters

direction:

Optional

(default: "desc")

Direction to sort objects

"asc"

"desc"

order:

Optional

(default: "created")

Order secrets by values in the given field

"name"

"comment"

"created"

"modified"

"status"

page: number

Optional

(minimum: 0, multipleOf: 1)

Page number

per_page: number

Optional

(maximum: 100, minimum: 0, multipleOf: 1)

Number of objects to return per page

scopes: Array<Array<string>>

Optional

Only secrets with the given scopes will be returned

search: string

Optional

Search secrets using a filter string, filtering across name and comment

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: Array<{ id, created, modified, 4 more... }>

Optional

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/secrets_store/stores/$STORE_ID/secrets \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "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": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "name": "MY_API_KEY",
      "status": "pending",
      "store_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "comment": "info about my secret"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

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