Lists a namespace's keys.
/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys
get
Workers KV Namespace
workers-kv-namespace-list-a-namespace'-s-keys
null{
"enum": [
"com.cloudflare.edge.storage.kv.key.list"
]
}[
{
"in": "path",
"name": "namespace_identifier",
"required": true,
"schema": {
"description": "Namespace identifier tag.",
"example": "0f2ac74b498b48028cb68387c421e279",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"default": 1000,
"description": "The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.",
"maximum": 1000,
"minimum": 10,
"type": "number"
}
},
{
"in": "query",
"name": "prefix",
"schema": {
"description": "A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.",
"example": "My-Prefix",
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"description": "Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the `cursors` object in the `result_info` structure.",
"example": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"description": "A name for a value. A value stored under a given key may be retrieved via the same key.",
"properties": {
"expiration": {
"description": "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.",
"example": 1577836800,
"type": "number"
},
"metadata": {
"description": "Arbitrary JSON that is associated with a key.",
"example": {
"someMetadataKey": "someMetadataValue"
},
"type": "object"
},
"name": {
"description": "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.",
"example": "My-Key",
"maxLength": 512,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total results returned based on your list parameters.",
"example": 1,
"type": "number"
},
"cursor": {
"description": "Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.",
"example": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw",
"type": "string"
}
}
}
}
}
]
}
}
},
"description": "List a Namespace's Keys response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"description": "A name for a value. A value stored under a given key may be retrieved via the same key.",
"properties": {
"expiration": {
"description": "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.",
"example": 1577836800,
"type": "number"
},
"metadata": {
"description": "Arbitrary JSON that is associated with a key.",
"example": {
"someMetadataKey": "someMetadataValue"
},
"type": "object"
},
"name": {
"description": "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.",
"example": "My-Key",
"maxLength": 512,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total results returned based on your list parameters.",
"example": 1,
"type": "number"
},
"cursor": {
"description": "Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.",
"example": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw",
"type": "string"
}
}
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List a Namespace's Keys response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]