api.md

KV

Namespaces

Types:

• Namespace
• NamespaceDeleteResponse
• NamespaceBulkDeleteResponse
• NamespaceBulkGetResponse
• NamespaceBulkUpdateResponse

Methods:

• client.kv.namespaces.create({ ...params }) -> Namespace
• client.kv.namespaces.update(namespaceId, { ...params }) -> Namespace
• client.kv.namespaces.list({ ...params }) -> NamespacesV4PagePaginationArray
• client.kv.namespaces.delete(namespaceId, { ...params }) -> NamespaceDeleteResponse | null
• client.kv.namespaces.bulkDelete(namespaceId, [ ...body ]) -> NamespaceBulkDeleteResponse | null
• client.kv.namespaces.bulkGet(namespaceId, { ...params }) -> NamespaceBulkGetResponse | null
• client.kv.namespaces.bulkUpdate(namespaceId, [ ...body ]) -> NamespaceBulkUpdateResponse | null
• client.kv.namespaces.get(namespaceId, { ...params }) -> Namespace

Keys

Types:

• Key
• KeyBulkDeleteResponse
• KeyBulkGetResponse
• KeyBulkUpdateResponse

Methods:

• client.kv.namespaces.keys.list(namespaceId, { ...params }) -> KeysCursorLimitPagination
• client.kv.namespaces.keys.bulkDelete(namespaceId, [ ...body ]) -> KeyBulkDeleteResponse | null
• client.kv.namespaces.keys.bulkGet(namespaceId, { ...params }) -> KeyBulkGetResponse | null
• client.kv.namespaces.keys.bulkUpdate(namespaceId, [ ...body ]) -> KeyBulkUpdateResponse | null

Metadata

Types:

• MetadataGetResponse

Methods:

• client.kv.namespaces.metadata.get(namespaceId, keyName, { ...params }) -> MetadataGetResponse

Values

Types:

• ValueUpdateResponse
• ValueDeleteResponse

Methods:

• client.kv.namespaces.values.update(namespaceId, keyName, { ...params }) -> ValueUpdateResponse | null
• client.kv.namespaces.values.delete(namespaceId, keyName, { ...params }) -> ValueDeleteResponse | null
• client.kv.namespaces.values.get(namespaceId, keyName, { ...params }) -> Response