Ninox Manual
Search…
Private Cloud APIs
All available Ninox Private Cloud API endpoints
Content in curly brackets { } signifies a placeholder. Both the curly brackets and the content within must be replaced for the request to work.
get
https://{private-cloud}.ninoxdb.de
/v1/teams
Get multiple teams

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}
Get a single team

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases
Get multiple databases

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}
Get a schema for a single database

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/views
Get a schema for multiple views

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/views
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/query
Execute a read-only query with GET

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/query?query=(select Contact).'First Name'
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/query
Execute a read-only query with POST
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/query
Execute a read-only query with POST

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/query
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
5
-D '{
6
"query": "(select Contact).'First Name'"
7
}'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/exec
Execute a writable query

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/exec
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
5
-D '{
6
"query": "users()"
7
}'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables
Get a schema for multiple tables

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams{teamid}/databases/{dbid}/tables/{tid}
Get a schema for a single table

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views
Get a schema of multiple views (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Get a shared view (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Create/update a shared view with POST (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Delete a shared view (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
2
-X DELETE
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Get multiple records

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Get a single record

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/1
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
put
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Update a single record with PUT

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records/1
2
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
3
-H 'Content-Type: application/json'
4
-D '{
5
"fields": {
6
"First name": "Jane"
7
}
8
}'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/record
Look up/search a single record with POST

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/record
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
5
-D '{
6
"filters": {
7
"A": "Jane"
8
}
9
}'
Copied!
The endpoint is /record, not /records.
To identify which filters are mapped to which ids, send a GET request to retrieve the schema of a single table.
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Create/update multiple records with POST

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
5
-D '[{
6
"id": 2,
7
"fields": {
8
"First name": "Dennis"
9
}
10
},{
11
"fields": {
12
"First name": "Jody"
13
}
14
}]'
Copied!
To update a record, specify a record id and the fields you wish to update in an existing record.
To create a record, do not specify the record id, only specify the fields you wish to create in a new record.
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Delete a single record

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records/1
2
-X DELETE
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Delete multiple records

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records
2
-X DELETE
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
5
-D '[7,8]'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Get a single file

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Upload a single file with POST

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: multipart/form-data'
5
-F '[email protected]"/Users/anastasiya/Downloads/iStock-184877012.jpeg"'
Copied!
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Delete a single file

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg
2
-X DELETE
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Get metadata for multiple files

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/metadata
Get metadata for a single file

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/123.jpeg/metadata
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/thumb.jpg
Get a thumbnail for a single file

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/123jpeg/thumb.jpg
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share
Get a single shared file (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg/share
2
-X GET
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share
Upload a single shared file with POST (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/mobile-phone.jpeg/share
2
-X POST
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables{tid}/records/{rid}/files/{file}/share
Delete a single shared file (not live yet)

Sample request

1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg/share
2
-X DELETE
3
-H 'Authorization: Bearer e66e5190-14ad-11ec-aa6f-3502731d486c'
4
-H 'Content-Type: application/json'
Copied!
Last modified 2mo ago