Get Keys List

get

https://{serverid}.nexusrun.com/databases/{databaseid}/buckets/{bucketid}/keys

This API endpoint lists all the available keys within a specific bucket in the NexusRunDB database.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Additionally, when using this API endpoint, you have the option to filter the results by key IDs. This allows you to retrieve specific keys from the NexusRunDB database based on search pattern.
The Master access key or user-generated access keys with "list_all_keys" permissions (or tokens generated for these access keys) have the ability to access this endpoint.

Path Params

databaseid

string

required

This is the unique database id you provided while creating database.

serverid

string

required

This is short name for the database location. This will be shown when new database is created at portal.

bucketid

string

required

Specifies the bucket id from which all keys are listed

Query Params

itemsperpage

int32

Defaults to 25

[Optional] Specifies no of items to return from List operation. Default value is 25 and maximum allowed value is 1000.

pageindex

int32

Defaults to 1

[Optional] Specifies index of result set for paging purpose.

filtertype

string

[Optional] Specifies type of filtering to reduce result set. Allowed values are "prefix","suffix" or "contains". This parameter is mandatory if 'filtertext' parameter is passed in API endpoint.

filtertext

string

[Optional] Specifies filter text to reduce result set. This parameter is mandatory if 'filtertype' parameter is passed in API endpoint.

Headers

Authorization

string

You need to pass either "Basic 'accesskey:accesssecret'" (base 64 encoded) or "Bearer {token}" authorization header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

404404

500500