Get an item from a kv store

GET

/api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project/kv/0000/items/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project/kv/0000/items/example \
  --header 'Authorization: Bearer <token>'

Retrieves an item from the KV store. Security Note: If the item was stored as a secret (secret=true), the value will be redacted and returned as ‘[ENCRYPTED]’ for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.

Authorizations

BearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

Example

test-org

project

required

string

Project identifier

Example

test-project

store_id

required

string

Example

key

required

string

Responses

200

The request has succeeded.

application/json

object

key

string

value

One of:

string
object

string

Example

{
  "key": "user-session-123"
}

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}

404

Item not found.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}