Skip to content
Cloudflare API
Start here
API Reference

Secrets Store

Secrets StoreStores

List account stores
client.secretsStore.stores.list(StoreListParams { account_id, direction, order, 2 more } params?, RequestOptionsoptions?): V4PagePaginationArray<StoreListResponse { id, created, modified, 2 more } >
GET/accounts/{account_id}/secrets_store/stores
Create a store
client.secretsStore.stores.create(StoreCreateParams { account_id, name } params, RequestOptionsoptions?): StoreCreateResponse { id, created, modified, 2 more }
POST/accounts/{account_id}/secrets_store/stores
Delete a store
client.secretsStore.stores.delete(stringstoreId, StoreDeleteParams { account_id } params?, RequestOptionsoptions?): StoreDeleteResponse | null
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}
ModelsExpand Collapse
StoreListResponse { 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?: string

Account Identifier

maxLength32
StoreCreateResponse { 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?: string

Account Identifier

maxLength32
StoreDeleteResponse = unknown

Result is null for delete operations.

Secrets StoreStoresSecrets

List store secrets
client.secretsStore.stores.secrets.list(stringstoreId, SecretListParams { account_id, direction, order, 4 more } params?, RequestOptionsoptions?): V4PagePaginationArray<SecretListResponse { id, created, modified, 5 more } >
GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Get a secret by ID
client.secretsStore.stores.secrets.get(stringstoreId, stringsecretId, SecretGetParams { account_id } params?, RequestOptionsoptions?): SecretGetResponse { id, created, modified, 5 more }
GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Create a secret
client.secretsStore.stores.secrets.create(stringstoreId, SecretCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<SecretCreateResponse { id, created, modified, 5 more } >
POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Patch a secret
client.secretsStore.stores.secrets.edit(stringstoreId, stringsecretId, SecretEditParams { account_id, comment, scopes, value } params, RequestOptionsoptions?): SecretEditResponse { id, created, modified, 5 more }
PATCH/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Delete a secret
client.secretsStore.stores.secrets.delete(stringstoreId, stringsecretId, SecretDeleteParams { account_id } params?, RequestOptionsoptions?): SecretDeleteResponse | null
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}
Delete secrets
client.secretsStore.stores.secrets.bulkDelete(stringstoreId, SecretBulkDeleteParams { account_id } params?, RequestOptionsoptions?): SecretBulkDeleteResponse | null
DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets
Duplicate Secret
client.secretsStore.stores.secrets.duplicate(stringstoreId, stringsecretId, SecretDuplicateParams { account_id, name, scopes, comment } params, RequestOptionsoptions?): SecretDuplicateResponse { id, created, modified, 5 more }
POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate
ModelsExpand Collapse
SecretListResponse { 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" | "active" | "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment?: string

Freeform text describing the secret

scopes?: Array<string>

The list of services that can use this secret.

SecretGetResponse { 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" | "active" | "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment?: string

Freeform text describing the secret

scopes?: Array<string>

The list of services that can use this secret.

SecretCreateResponse { 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" | "active" | "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment?: string

Freeform text describing the secret

scopes?: Array<string>

The list of services that can use this secret.

SecretEditResponse { 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" | "active" | "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment?: string

Freeform text describing the secret

scopes?: Array<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 { 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" | "active" | "deleted"
One of the following:
"pending"
"active"
"deleted"
store_id: string

Store Identifier

maxLength32
comment?: string

Freeform text describing the secret

scopes?: Array<string>

The list of services that can use this secret.

Secrets StoreQuota

View secret usage
client.secretsStore.quota.get(QuotaGetParams { account_id } params?, RequestOptionsoptions?): QuotaGetResponse { secrets }
GET/accounts/{account_id}/secrets_store/quota
ModelsExpand Collapse
QuotaGetResponse { secrets }
secrets: Secrets { 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