Collections APIs

APIs for generic storage of documents.

Retrieve statistics for the specified collection.

get

This endpoint provides detailed statistics about the tables that exist within the specified collection. It is intended for users with access to the organization's data, allowing them to understand the structure and contents of their collections.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

Responses

200

OK

*/*

Responsestring[]

401

Unauthorized

*/*

get

/{orgId}/collections

HTTPcURLJavaScriptPython

GET /{orgId}/collections HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

Remove an entire collection for the organization

delete

This endpoint permanently deletes the specified collection associated with the given organization ID. Ensure that you have the necessary permissions to perform this action. This operation is critical and should be used with caution to prevent data loss.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/{orgId}/collections

HTTPcURLJavaScriptPython

DELETE /{orgId}/collections HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "success": true
}

Retrieve statistics for a specific document table.

get

This endpoint returns detailed statistics about the specified table within the organization. It provides insights into document counts and other relevant metrics. Access is controlled and requires appropriate authentication to ensure data security.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/{orgId}/collections/{table}

HTTPcURLJavaScriptPython

GET /{orgId}/collections/{table} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "query_docs_total": 1,
  "query_read_docs_per_sec": 1,
  "query_written_docs_total": 1,
  "query_written_docs_per_sec": 1
}

Insert a document into the specified collection.

post

This endpoint allows users to insert a document into the specified collection within the database. If a document with the same ID already exists, an exception will be thrown. Ensure that the provided data adheres to the expected schema to avoid errors.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

Body

application/json

objectOptional

Responses

200

OK

*/*

Responseobject

401

Unauthorized

*/*

post

/{orgId}/collections/{table}

HTTPcURLJavaScriptPython

POST /{orgId}/collections/{table} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}

Remove an entire collection table for the organization.

delete

This endpoint allows the deletion of an entire table within a specified collection. It is intended for use by authorized users to manage their data effectively. Ensure that the correct organization ID and table name are provided to avoid accidental data loss.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

Query parameters

qstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/{orgId}/collections/{table}

HTTPcURLJavaScriptPython

DELETE /{orgId}/collections/{table}?q=text HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "success": true
}

Add an index to a specified collection table.

put

This endpoint allows you to add an index to a specific table within a collection. It is essential for optimizing query performance and ensuring efficient data retrieval. Proper indexing enhances the overall responsiveness of your document storage operations.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

indexstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

put

/{orgId}/collections/{table}/.index/{index}

HTTPcURLJavaScriptPython

PUT /{orgId}/collections/{table}/.index/{index} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

get

Path parameters

orgIdstringRequired

tablestringRequired

Query parameters

qstringOptional

startinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 10

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/{orgId}/collections/{table}/.metadata/ids

HTTPcURLJavaScriptPython

GET /{orgId}/collections/{table}/.metadata/ids HTTP/1.1
Host: gateway.dev.klustr.io
Accept: */*

{
  "count": 1,
  "limit": 1,
  "skip": 1,
  "docs": [
    "text"
  ]
}

Bulk insert documents into the specified collection

post

This endpoint allows for the bulk insertion of multiple documents into a specified collection. If any document ID already exists, the entire request will fail with a 400 error. Ensure that the provided IDs are unique to prevent request failure.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

Bodyobject[]

application/json

object[]Optional

Responses

200

OK

*/*

Responseobject[]

401

Unauthorized

*/*

post

/{orgId}/collections/{table}/bulk

HTTPcURLJavaScriptPython

POST /{orgId}/collections/{table}/bulk HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4

[
  {}
]

[
  {}
]

get

Path parameters

orgIdstringRequired

tablestringRequired

Query parameters

qstringOptional

fqstring[]Optional

startinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 10

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/{orgId}/collections/{table}/search

HTTPcURLJavaScriptPython

GET /{orgId}/collections/{table}/search HTTP/1.1
Host: gateway.dev.klustr.io
Accept: */*

{
  "count": 1,
  "limit": 1,
  "skip": 1,
  "docs": [
    {}
  ]
}

Retrieve a document by its unique identifier.

get

This API endpoint allows users to fetch a specific document using its ID. It is designed for accessing documents within a given organization and table. Ensure that you have the necessary permissions to access the document.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

idstringRequired

Responses

200

OK

*/*

Responseobject

401

Unauthorized

*/*

get

/{orgId}/collections/{table}/{id}

HTTPcURLJavaScriptPython

GET /{orgId}/collections/{table}/{id} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{}

Update a document in the specified collection.

put

This endpoint allows you to update a specific document identified by its ID within a given collection. Ensure that the correct organization ID and table name are provided. Use the If-Match header for concurrency control to prevent overwriting changes made by others.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

idstringRequired

Header parameters

If-MatchstringOptional

Body

application/json

objectOptional

Responses

200

OK

*/*

Responseobject

401

Unauthorized

*/*

put

/{orgId}/collections/{table}/{id}

HTTPcURLJavaScriptPython

PUT /{orgId}/collections/{table}/{id} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}

Delete a specific document from a collection.

delete

This endpoint allows the deletion of a specified document from a collection within an organization. It requires the organization ID, table name, and document ID. Optionally, an ETag can be provided for concurrency control.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

orgIdstringRequired

tablestringRequired

idstringRequired

Header parameters

If-MatchstringOptional

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/{orgId}/collections/{table}/{id}

HTTPcURLJavaScriptPython

DELETE /{orgId}/collections/{table}/{id} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content