{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cloudflare Workers KV Workers KV Namespace API",
    "version": "4.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Workers KV Namespace",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Namespaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the namespaces owned by an account."
        },
        {
          "info": {
            "name": "Create a Namespace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced."
        },
        {
          "info": {
            "name": "Get a Namespace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the namespace corresponding to the given ID."
        },
        {
          "info": {
            "name": "Rename a Namespace",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies a namespace's title."
        },
        {
          "info": {
            "name": "Remove a Namespace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes the namespace corresponding to the given ID."
        },
        {
          "info": {
            "name": "Write multiple key-value pairs",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less."
        },
        {
          "info": {
            "name": "Delete multiple key-value pairs",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed."
        },
        {
          "info": {
            "name": "Delete multiple key-value pairs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk/delete",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed."
        },
        {
          "info": {
            "name": "Get multiple key-value pairs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk/get",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if `withMetadata` is true."
        },
        {
          "info": {
            "name": "List a Namespace's Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/keys",
            "params": [
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "prefix",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Lists a namespace's keys."
        },
        {
          "info": {
            "name": "Read the metadata for a key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/metadata/:key_name",
            "params": [
              {
                "name": "key_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name."
        },
        {
          "info": {
            "name": "Read key-value pair",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name",
            "params": [
              {
                "name": "key_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header."
        },
        {
          "info": {
            "name": "Write key-value pair with optional metadata",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name",
            "params": [
              {
                "name": "key_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expiration",
                "value": "",
                "type": "query"
              },
              {
                "name": "expiration_ttl",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "metadata",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "value",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored. If JSON metadata to be associated with the key/value pair is needed, use `multipart/form-data` content type for your PUT request (see dropdown below in `REQUEST BODY SCHEMA`). Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. "
        },
        {
          "info": {
            "name": "Delete key-value pair",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name",
            "params": [
              {
                "name": "key_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "namespace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name."
        }
      ]
    }
  ],
  "bundled": true
}