Skip to content
Cloudflare API
Start here
API Reference
Secrets Store
Stores
Secrets

List store secrets

secrets_store.stores.secrets.list(strstore_id, SecretListParams**kwargs) -> SyncV4PagePaginationArray[SecretListResponse]
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 WriteSecrets Store Read
ParametersExpand Collapse
account_id: str

Account Identifier

maxLength32
store_id: str

Store Identifier

maxLength32
direction: Optional[Literal["asc", "desc"]]

Direction to sort objects

One of the following:
"asc"
"desc"
order: Optional[Literal["name", "comment", "created", 2 more]]

Order secrets by values in the given field

One of the following:
"name"
"comment"
"created"
"modified"
"status"
page: Optional[int]

Page number

minimum0
multipleOf1
per_page: Optional[int]

Number of objects to return per page

maximum100
minimum0
multipleOf1
scopes: Optional[Iterable[SequenceNotStr[str]]]

Only secrets with the given scopes will be returned

ReturnsExpand Collapse
class SecretListResponse: …
id: str

Secret identifier tag.

maxLength32
created: datetime

Whenthe secret was created.

formatdate-time
modified: datetime

When the secret was modified.

formatdate-time
name: str

The name of the secret

status: Literal["pending", "active", "deleted"]
One of the following:
"pending"
"active"
"deleted"
store_id: str

Store Identifier

maxLength32
comment: Optional[str]

Freeform text describing the secret

List store secrets

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.secrets_store.stores.secrets.list(
    store_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="985e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "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
  }
}
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": [
    {
      "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
  }
}