Key Value

Gets keys from key-value collection

Fetch keys from key-value collection.

get/_fabric/{fabric}/_api/kv/{collection}/keys

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/kv/:collection/keys/get.ts
A function with typed inputs. Its response is checked against the schema.

fabricstring string required

The name of the fabric.

collectionstring string required

The name of the key-value collection.

groupIDstring string

Get keys belonging to this groupID.

offsetstring

This option simulates paging.

limitstring

This option limits results while simulating paging.

orderstring

Order the results ascending (asc) or descending (desc).

Successfully fetched the key-value keys.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultstring[]

An array of keys. If there are no results, the array is returned as empty.

{
  "code": 200,
  "result": [
    "data"
  ]
}

No recorded changes to this operation across all 1 revision of this API.