List all collections in an app’s database

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Collection Names
data
object[]

Resource Data

name
string

The name of the collection

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Create a collection in an app’s database

Request Body

schema application/json
name
string

A name for the new collection (lowercase letters, numbers, underscores allowed)

Response

201 Collection
data
object

Resource Data

disk_usage
integer
(int32)

The amount of space the collection is using in MB

document_count
integer
(int32)

The number of documents in the collection

name
string

The name of the collection

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Retrieve info about a collection in an app’s database

Path Parameters

name
string

Collection name

Response

200 Collection
data
object

Resource Data

disk_usage
integer
(int32)

The amount of space the collection is using in MB

document_count
integer
(int32)

The number of documents in the collection

name
string

The name of the collection

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Delete a collection in an app’s database

Path Parameters

name
string

Collection name

Response

204 No Content

Create a document within a collection

Path Parameters

name

Collection name

Response

201 Document
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

List documents within a collection matching query

Path Parameters

name

Collection name

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Documents
data
[]

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Return a document within a collection

Path Parameters

doc_id
string

Document ID

name

Collection name

Response

200 Document
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Replace a document within a collection or insert one if it did not exist.

Path Parameters

doc_id
string

Document ID

name

Collection name

Response

200 Document Replaced
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

201 Document Inserted
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Update only the specified fields of an existing document within a collection

Path Parameters

doc_id
string

Document ID

name

Collection name

Response

204 No Content (update successful)

Delete a document in a collection

Path Parameters

doc_id
string

Document ID

name

Collection name

Response

204 No Content

List groups within a database

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Groups
data
object[]

Resource Data

name
string

The name of the group

rule_count
integer
(int32)

The number of rules associated with the group

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Retrieve a group within a database

Path Parameters

group_name
string

Group name

Response

200 Groups
data
object

Resource Data

name
string

The name of the group

rule_count
integer
(int32)

The number of rules associated with the group

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

List rules for a group

Path Parameters

group_name

The group housing the target rule

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Rules
data
object[]

Resource Data

collection
string

The name of the collection the rule act upon

custom_rule
string

Optional, A string describing the custom rule if rule type is custom

name
string

The name of the rule

rule
string

The type of rule (read, write, custom)

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Create a rule for a group

Path Parameters

group_name

The group housing the target rule

Request Body

schema application/json
collection
string

Collection name

custom_rule
string

Custom rule text

name
string

Rule name (lowercase letters, numbers, underscores allowed)

rule
string

Rule type (read, write, custom)

Response

200 Rule
data
object

Resource Data

collection
string

The name of the collection the rule act upon

custom_rule
string

Optional, A string describing the custom rule if rule type is custom

name
string

The name of the rule

rule
string

The type of rule (read, write, custom)

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

group_name

The group housing the target rule

rule_name
string

The name of the rule

Response

200 Rule
data
object

Resource Data

collection
string

The name of the collection the rule act upon

custom_rule
string

Optional, A string describing the custom rule if rule type is custom

name
string

The name of the rule

rule
string

The type of rule (read, write, custom)

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Replace a rule for a group or insert a rule if one doesn’t exist.

Path Parameters

group_name

The group housing the target rule

rule_name
string

The name of the rule

Request Body

schema application/json
collection
string

Collection name

custom_rule
string

Custom rule text

rule
string

Rule type (read, write, custom)

Response

200 Rule
data
object

Resource Data

collection
string

The name of the collection the rule act upon

custom_rule
string

Optional, A string describing the custom rule if rule type is custom

name
string

The name of the rule

rule
string

The type of rule (read, write, custom)

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

group_name

The group housing the target rule

rule_name
string

The name of the rule

Response

204 No Content

Models

The following is a collection of model references

Rule

schema application/json
collection
string

The name of the collection the rule act upon

custom_rule
string

Optional, A string describing the custom rule if rule type is custom

name
string

The name of the rule

rule
string

The type of rule (read, write, custom)

Collection

schema application/json
disk_usage
integer
(int32)

The amount of space the collection is using in MB

document_count
integer
(int32)

The number of documents in the collection

name
string

The name of the collection

CollectionName

schema application/json
name
string

The name of the collection

Group

schema application/json
name
string

The name of the group

rule_count
integer
(int32)

The number of rules associated with the group

Services

    API

      General