List a Namespace's Keys

Lists a namespace's keys.

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

required

Any of

allOf {2}

array[object (key) {3}]

allOf {2}

One of

array[object (key) {3}]

object

expiration

number

optional

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

metadata

object

list_metadata

optional

Arbitrary JSON that is associated with a key.

Example:

{"someMetadataKey":"someMetadataValue"}

name

string

key_name

required

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.

<= 512 characters

Example:

My-Key

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

optional

count

number

optional

Total results returned based on your list parameters.

Example:

cursor

string

cursor

optional

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

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "expiration": 1577836800,
            "metadata": {
                "someMetadataKey": "someMetadataValue"
            },
            "name": "My-Key"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "cursor": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"
    }
}

List a Namespace's Keys

Request

Request samples

Responses