Skip to content
Cloudflare API
Start here
API Reference

Secrets Store

Secrets StoreStores

List account stores
GET/accounts/{account_id}/secrets_store/stores
Create a store
POST/accounts/{account_id}/secrets_store/stores
Delete a store
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}
ModelsExpand Collapse
StoreListResponse object { id, created, modified, 2 more }
id: string

Store Identifier

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the store

account_id: optional string

Account Identifier

maxLength32
StoreCreateResponse object { id, created, modified, 2 more }
id: string

Store Identifier

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the store

account_id: optional string

Account Identifier

maxLength32
StoreDeleteResponse = unknown

Result is null for delete operations.

Secrets StoreStoresSecrets

List store secrets
GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Get a secret by ID
GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Create a secret
POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Patch a secret
PATCH/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Delete a secret
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Delete secrets
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Duplicate Secret
POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate
ModelsExpand Collapse
SecretListResponse object { id, created, modified, 5 more }
id: string

Secret identifier tag.

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the secret

status: "pending" or "active" or "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment: optional string

Freeform text describing the secret

scopes: optional array of string

The list of services that can use this secret.

SecretGetResponse object { id, created, modified, 5 more }
id: string

Secret identifier tag.

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the secret

status: "pending" or "active" or "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment: optional string

Freeform text describing the secret

scopes: optional array of string

The list of services that can use this secret.

SecretCreateResponse object { id, created, modified, 5 more }
id: string

Secret identifier tag.

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the secret

status: "pending" or "active" or "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment: optional string

Freeform text describing the secret

scopes: optional array of string

The list of services that can use this secret.

SecretEditResponse object { id, created, modified, 5 more }
id: string

Secret identifier tag.

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the secret

status: "pending" or "active" or "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment: optional string

Freeform text describing the secret

scopes: optional array of string

The list of services that can use this secret.

SecretDeleteResponse = unknown

Result is null for delete operations.

SecretBulkDeleteResponse = unknown

Result is null for delete operations.

SecretDuplicateResponse object { id, created, modified, 5 more }
id: string

Secret identifier tag.

maxLength32
created: string

Whenthe secret was created.

formatdate-time
modified: string

When the secret was modified.

formatdate-time
name: string

The name of the secret

status: "pending" or "active" or "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment: optional string

Freeform text describing the secret

scopes: optional array of string

The list of services that can use this secret.

Secrets StoreQuota

View secret usage
GET/accounts/{account_id}/secrets_store/quota
ModelsExpand Collapse
QuotaGetResponse object { secrets }
secrets: object { quota, usage }
quota: number

The number of secrets the account is entitlted to use

usage: number

The number of secrets the account is currently using