--- title: Namespaces --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [KV](https://developers.cloudflare.com/api/typescript/resources/kv) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Namespaces ##### [List namespaces](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/list) client.kv.namespaces.list(NamespaceListParams {account\_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [Namespace]() {id, title, jurisdiction, 2 more } > GET/accounts/{account\_id}/storage/kv/namespaces ##### [Get a namespace](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/get) client.kv.namespaces.get(stringnamespaceID, NamespaceGetParams {account\_id } params, RequestOptionsoptions?): [Namespace]() {id, title, jurisdiction, 2 more } GET/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id} ##### [Create a namespace](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/create) client.kv.namespaces.create(NamespaceCreateParams {account\_id, title, jurisdiction, mode } params, RequestOptionsoptions?): [Namespace]() {id, title, jurisdiction, 2 more } POST/accounts/{account\_id}/storage/kv/namespaces ##### [Rename a namespace](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/update) client.kv.namespaces.update(stringnamespaceID, NamespaceUpdateParams {account\_id, title } params, RequestOptionsoptions?): [Namespace]() {id, title, jurisdiction, 2 more } PUT/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id} ##### [Delete a namespace](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/delete) client.kv.namespaces.delete(stringnamespaceID, NamespaceDeleteParams {account\_id } params, RequestOptionsoptions?): [NamespaceDeleteResponse]()| null DELETE/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id} ##### [Write multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/bulk_update) client.kv.namespaces.bulkUpdate(stringnamespaceID, NamespaceBulkUpdateParams {account\_id, body } params, RequestOptionsoptions?): [NamespaceBulkUpdateResponse]() {successful\_key\_count, unsuccessful\_keys } | null PUT/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk ##### [Delete multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/bulk_delete) client.kv.namespaces.bulkDelete(stringnamespaceID, NamespaceBulkDeleteParams {account\_id, body } params, RequestOptionsoptions?): [NamespaceBulkDeleteResponse]() {successful\_key\_count, unsuccessful\_keys } | null POST/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk/delete ##### [Get multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/methods/bulk_get) client.kv.namespaces.bulkGet(stringnamespaceID, NamespaceBulkGetParams {account\_id, keys, type, withMetadata } params, RequestOptionsoptions?): [NamespaceBulkGetResponse]()| null POST/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk/get ##### ModelsExpand Collapse
Namespace {id, title, jurisdiction, 2 more } id: string ID of the Workers KV namespace. maxLength32 Link to this property title: string Human-readable string name for a Workers KV namespace. maxLength512 Link to this property
jurisdiction?: "eu"| "fedramp"| "us" Specify the jurisdiction to restrict the KV namespace to durably store data within. Can only be set at namespace creation time. One of the following: "eu" Link to this property "fedramp" Link to this property "us" Link to this property
Link to this property mode?: "instant" The mode of the Workers KV namespace. Specify instant when creating a namespace to create a KV Instant namespace. Omit this field when creating a namespace to create a classic namespace. Currently, instant is the only supported explicit value. Link to this property supports\_url\_encoding?: boolean True if keys written on the URL will be URL-decoded before storing. For example, if set to “true”, a key written on the URL as “%3F” will be stored as ”?”. Link to this property
[Link to this property](<#(resource)%20kv.namespaces%20%3E%20(model)%20namespace%20%3E%20(schema)>) NamespaceDeleteResponse [Link to this property](<#(resource)%20kv.namespaces%20%3E%20(model)%20namespace_delete_response%20%3E%20(schema)>)
NamespaceBulkUpdateResponse {successful\_key\_count, unsuccessful\_keys } successful\_key\_count?: number Number of keys successfully written or deleted by the bulk operation. Link to this property unsuccessful\_keys?: Array<string> Names of keys that failed to be written or deleted. Retry the operation for these keys. Link to this property
[Link to this property](<#(resource)%20kv.namespaces%20%3E%20(model)%20namespace_bulk_update_response%20%3E%20(schema)>)
NamespaceBulkDeleteResponse {successful\_key\_count, unsuccessful\_keys } successful\_key\_count?: number Number of keys successfully written or deleted by the bulk operation. Link to this property unsuccessful\_keys?: Array<string> Names of keys that failed to be written or deleted. Retry the operation for these keys. Link to this property
[Link to this property](<#(resource)%20kv.namespaces%20%3E%20(model)%20namespace_bulk_delete_response%20%3E%20(schema)>)
NamespaceBulkGetResponse = WorkersKVBulkGetResult {values } | WorkersKVBulkGetResultWithMetadata {values } | null One of the following:
WorkersKVBulkGetResult {values }
values?: Record<string, string| number| boolean| Record<string, unknown>> Requested keys are paired with their values in an object. One of the following: string Link to this property number Link to this property boolean Link to this property Record<string, unknown> Link to this property
Link to this property
Link to this property
WorkersKVBulkGetResultWithMetadata {values }
values?: Record<string, Values| null> Requested keys are paired with their values and metadata in an object. metadata: unknown The metadata associated with the key. Link to this property value: unknown The value associated with the key. Link to this property expiration?: number Expires the key at a certain time, measured in number of seconds since the UNIX epoch. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20kv.namespaces%20%3E%20(model)%20namespace_bulk_get_response%20%3E%20(schema)>) #### NamespacesKeys ##### [List keys in a namespace](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/keys/methods/list) client.kv.namespaces.keys.list(stringnamespaceID, KeyListParams {account\_id, cursor, limit, prefix } params, RequestOptionsoptions?): CursorLimitPagination< [Key]() {name, expiration, metadata } > GET/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/keys ##### [Write multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/keys/methods/bulk_update) Deprecated client.kv.namespaces.keys.bulkUpdate(stringnamespaceID, KeyBulkUpdateParams {account\_id, body } params, RequestOptionsoptions?): [KeyBulkUpdateResponse]() {successful\_key\_count, unsuccessful\_keys } | null PUT/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk ##### [Delete multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/keys/methods/bulk_delete) Deprecated client.kv.namespaces.keys.bulkDelete(stringnamespaceID, KeyBulkDeleteParams {account\_id, body } params, RequestOptionsoptions?): [KeyBulkDeleteResponse]() {successful\_key\_count, unsuccessful\_keys } | null POST/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk/delete ##### [Get multiple key-value pairs](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/keys/methods/bulk_get) Deprecated client.kv.namespaces.keys.bulkGet(stringnamespaceID, KeyBulkGetParams {account\_id, keys, type, withMetadata } params, RequestOptionsoptions?): [KeyBulkGetResponse]()| null POST/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/bulk/get ##### ModelsExpand Collapse
Key {name, expiration, metadata } A name for a value. A value stored under a given key may be retrieved via the same key. name: string A key’s name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL. maxLength512 Link to this property expiration?: number The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire. Link to this property metadata?: unknown Arbitrary JSON that is associated with a key. Link to this property
[Link to this property](<#(resource)%20kv.namespaces.keys%20%3E%20(model)%20key%20%3E%20(schema)>)
KeyBulkUpdateResponse {successful\_key\_count, unsuccessful\_keys } successful\_key\_count?: number Number of keys successfully written or deleted by the bulk operation. Link to this property unsuccessful\_keys?: Array<string> Names of keys that failed to be written or deleted. Retry the operation for these keys. Link to this property
[Link to this property](<#(resource)%20kv.namespaces.keys%20%3E%20(model)%20key_bulk_update_response%20%3E%20(schema)>)
KeyBulkDeleteResponse {successful\_key\_count, unsuccessful\_keys } successful\_key\_count?: number Number of keys successfully written or deleted by the bulk operation. Link to this property unsuccessful\_keys?: Array<string> Names of keys that failed to be written or deleted. Retry the operation for these keys. Link to this property
[Link to this property](<#(resource)%20kv.namespaces.keys%20%3E%20(model)%20key_bulk_delete_response%20%3E%20(schema)>)
KeyBulkGetResponse = WorkersKVBulkGetResult {values } | WorkersKVBulkGetResultWithMetadata {values } | null One of the following:
WorkersKVBulkGetResult {values }
values?: Record<string, string| number| boolean| Record<string, unknown>> Requested keys are paired with their values in an object. One of the following: string Link to this property number Link to this property boolean Link to this property Record<string, unknown> Link to this property
Link to this property
Link to this property
WorkersKVBulkGetResultWithMetadata {values }
values?: Record<string, Values| null> Requested keys are paired with their values and metadata in an object. metadata: unknown The metadata associated with the key. Link to this property value: unknown The value associated with the key. Link to this property expiration?: number Expires the key at a certain time, measured in number of seconds since the UNIX epoch. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20kv.namespaces.keys%20%3E%20(model)%20key_bulk_get_response%20%3E%20(schema)>) #### NamespacesMetadata ##### [Get a key's metadata](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/metadata/methods/get) client.kv.namespaces.metadata.get(stringkeyName, MetadataGetParams {account\_id, namespace\_id } params, RequestOptionsoptions?): [MetadataGetResponse]() GET/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/metadata/{key\_name} ##### ModelsExpand Collapse MetadataGetResponse = unknown Arbitrary JSON that is associated with a key. [Link to this property](<#(resource)%20kv.namespaces.metadata%20%3E%20(model)%20metadata_get_response%20%3E%20(schema)>) #### NamespacesValues ##### [Get a key's value](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/values/methods/get) client.kv.namespaces.values.get(stringkeyName, ValueGetParams {account\_id, namespace\_id } params, RequestOptionsoptions?): Response GET/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/values/{key\_name} ##### [Write a key-value pair with optional metadata](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/values/methods/update) client.kv.namespaces.values.update(stringkeyName, ValueUpdateParams {account\_id, namespace\_id, value, 3 more } params, RequestOptionsoptions?): [ValueUpdateResponse]()| null PUT/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/values/{key\_name} ##### [Delete a key-value pair](https://developers.cloudflare.com/api/typescript/resources/kv/subresources/namespaces/subresources/values/methods/delete) client.kv.namespaces.values.delete(stringkeyName, ValueDeleteParams {account\_id, namespace\_id } params, RequestOptionsoptions?): [ValueDeleteResponse]()| null DELETE/accounts/{account\_id}/storage/kv/namespaces/{namespace\_id}/values/{key\_name} ##### ModelsExpand Collapse ValueUpdateResponse [Link to this property](<#(resource)%20kv.namespaces.values%20%3E%20(model)%20value_update_response%20%3E%20(schema)>) ValueDeleteResponse [Link to this property](<#(resource)%20kv.namespaces.values%20%3E%20(model)%20value_delete_response%20%3E%20(schema)>)