--- title: Secrets Store --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Secrets Store #### Secrets StoreStores ##### [List account stores](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/methods/list) 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 ##### [Get a store by ID](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/methods/get) client.secretsStore.stores.get(stringstoreID, StoreGetParams {account\_id } params, RequestOptionsoptions?): [StoreGetResponse]() {id, created, modified, 2 more } GET/accounts/{account\_id}/secrets\_store/stores/{store\_id} ##### [Create a store](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/methods/delete) client.secretsStore.stores.delete(stringstoreID, StoreDeleteParams {account\_id, force } 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 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the store. Link to this property account\_id?: string Account Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20secrets_store.stores%20%3E%20(model)%20store_list_response%20%3E%20(schema)>)
StoreGetResponse {id, created, modified, 2 more } id: string Store Identifier. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the store. Link to this property account\_id?: string Account Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20secrets_store.stores%20%3E%20(model)%20store_get_response%20%3E%20(schema)>)
StoreCreateResponse {id, created, modified, 2 more } id: string Store Identifier. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the store. Link to this property account\_id?: string Account Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20secrets_store.stores%20%3E%20(model)%20store_create_response%20%3E%20(schema)>) StoreDeleteResponse = unknown Result is null for delete operations. [Link to this property](<#(resource)%20secrets_store.stores%20%3E%20(model)%20store_delete_response%20%3E%20(schema)>) #### Secrets StoreStoresSecrets ##### [List store secrets](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/get) client.secretsStore.stores.secrets.get(stringsecretID, SecretGetParams {account\_id, store\_id } params, RequestOptionsoptions?): [SecretGetResponse]() {id, created, modified, 5 more } GET/accounts/{account\_id}/secrets\_store/stores/{store\_id}/secrets/{secret\_id} ##### [Create a secret](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/edit) client.secretsStore.stores.secrets.edit(stringsecretID, SecretEditParams {account\_id, store\_id, comment, 2 more } params, RequestOptionsoptions?): [SecretEditResponse]() {id, created, modified, 5 more } PATCH/accounts/{account\_id}/secrets\_store/stores/{store\_id}/secrets/{secret\_id} ##### [Delete a secret](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/delete) client.secretsStore.stores.secrets.delete(stringsecretID, SecretDeleteParams {account\_id, store\_id } params, RequestOptionsoptions?): [SecretDeleteResponse]()| null DELETE/accounts/{account\_id}/secrets\_store/stores/{store\_id}/secrets/{secret\_id} ##### [Delete secrets](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/bulk_delete) 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](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/stores/subresources/secrets/methods/duplicate) client.secretsStore.stores.secrets.duplicate(stringsecretID, SecretDuplicateParams {account\_id, store\_id, name, 2 more } 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 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the secret. Link to this property
status: "pending"| "active"| "deleted" One of the following: "pending" Link to this property "active" Link to this property "deleted" Link to this property
Link to this property store\_id: string Store Identifier. maxLength32 Link to this property comment?: string Freeform text describing the secret. Link to this property
scopes?: Array<"workers"| "ai\_gateway"| "dex"| 3 more> The list of services that can use this secret. One of the following: "workers" Link to this property "ai\_gateway" Link to this property "dex" Link to this property "access" Link to this property "containers" Link to this property "websearch" Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_list_response%20%3E%20(schema)>)
SecretGetResponse {id, created, modified, 5 more } id: string Secret identifier tag. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the secret. Link to this property
status: "pending"| "active"| "deleted" One of the following: "pending" Link to this property "active" Link to this property "deleted" Link to this property
Link to this property store\_id: string Store Identifier. maxLength32 Link to this property comment?: string Freeform text describing the secret. Link to this property
scopes?: Array<"workers"| "ai\_gateway"| "dex"| 3 more> The list of services that can use this secret. One of the following: "workers" Link to this property "ai\_gateway" Link to this property "dex" Link to this property "access" Link to this property "containers" Link to this property "websearch" Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_get_response%20%3E%20(schema)>)
SecretCreateResponse {id, created, modified, 5 more } id: string Secret identifier tag. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the secret. Link to this property
status: "pending"| "active"| "deleted" One of the following: "pending" Link to this property "active" Link to this property "deleted" Link to this property
Link to this property store\_id: string Store Identifier. maxLength32 Link to this property comment?: string Freeform text describing the secret. Link to this property
scopes?: Array<"workers"| "ai\_gateway"| "dex"| 3 more> The list of services that can use this secret. One of the following: "workers" Link to this property "ai\_gateway" Link to this property "dex" Link to this property "access" Link to this property "containers" Link to this property "websearch" Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_create_response%20%3E%20(schema)>)
SecretEditResponse {id, created, modified, 5 more } id: string Secret identifier tag. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the secret. Link to this property
status: "pending"| "active"| "deleted" One of the following: "pending" Link to this property "active" Link to this property "deleted" Link to this property
Link to this property store\_id: string Store Identifier. maxLength32 Link to this property comment?: string Freeform text describing the secret. Link to this property
scopes?: Array<"workers"| "ai\_gateway"| "dex"| 3 more> The list of services that can use this secret. One of the following: "workers" Link to this property "ai\_gateway" Link to this property "dex" Link to this property "access" Link to this property "containers" Link to this property "websearch" Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_edit_response%20%3E%20(schema)>) SecretDeleteResponse = unknown Result is null for delete operations. [Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_delete_response%20%3E%20(schema)>) SecretBulkDeleteResponse = unknown Result is null for delete operations. [Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_bulk_delete_response%20%3E%20(schema)>)
SecretDuplicateResponse {id, created, modified, 5 more } id: string Secret identifier tag. maxLength32 Link to this property created: string When the secret was created. formatdate-time Link to this property modified: string When the secret was modified. formatdate-time Link to this property name: string The name of the secret. Link to this property
status: "pending"| "active"| "deleted" One of the following: "pending" Link to this property "active" Link to this property "deleted" Link to this property
Link to this property store\_id: string Store Identifier. maxLength32 Link to this property comment?: string Freeform text describing the secret. Link to this property
scopes?: Array<"workers"| "ai\_gateway"| "dex"| 3 more> The list of services that can use this secret. One of the following: "workers" Link to this property "ai\_gateway" Link to this property "dex" Link to this property "access" Link to this property "containers" Link to this property "websearch" Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.stores.secrets%20%3E%20(model)%20secret_duplicate_response%20%3E%20(schema)>) #### Secrets StoreQuota ##### [View secret usage](https://developers.cloudflare.com/api/typescript/resources/secrets_store/subresources/quota/methods/get) 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 entitled to use. Link to this property usage: number The number of secrets the account is currently using. Link to this property
Link to this property
[Link to this property](<#(resource)%20secrets_store.quota%20%3E%20(model)%20quota_get_response%20%3E%20(schema)>)