Comment on page
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 workspaces
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"
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}
Get a single workspace
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"
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"
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"
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"
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"
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
}'
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
}'
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"
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"
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views
Get a schema of multiple views
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"
​
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Get a shared view 
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"
​
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Create/update a shared view with POST
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"
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share
Delete a shared view
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"
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"
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"
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
}'
get
https://{private-cloud}.ninoxdb.de/
v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Look up/search a single record with GET
To identify which filters are mapped to which ids, send a GET request to retrieve the schema of a single table.
To look up a record with GET, make sure the endpoint is/records. The result will be the same as in Look up/search a single record with POST.
Sample request
1
curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/records
2
-X GET
3
-H "Content-Type": "application/json"
4
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
5
-D '{
6
    "filters": {
7
        "L": "Jane"
8
    }
9
}'
Alternative notation
An alternative notation of the example sample request above is to include the parameter filters in the URL and leave D (data) empty.
1
https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/records?filters={"L":"Jane"}
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/record
Look up/search a single record with POST
To identify which filters are mapped to which ids, send a GET request to retrieve the schema of a single table.
To look up a record with POST, make sure the endpoint is/record. The result will be the same as in Look up/search a single record with GET.
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
        "L": "Jane"
8
    }
9
}'
Alternative notation
An alternative notation of the example sample request above is to include the parameter filters in the URL and leave D (data) empty.
1
https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/record?filters={"L":"Jane"}
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
}]'
To update an existing record, specify a record id and the fields you wish to update in a record.
To create a new record, do not specify the record id, only specify the fields you wish to create in a record.
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Upsert (update/insert) multiple records with POST
Sample request
1
curl https://anastasiya.ninoxdb.de/v1/teams/c1w72a5wl28zzmpn9/databases/m8u2w3ulmgt3/tables/A/records
2
-X POST
3
-H "Authorization": "Bearer 90472720-5244-11ee-966b-d50b6af8825c"
4
-H "Content-Type": "application/json"
5
-D '[{
6
		"_upsert": true,
7
		"_id": 43,
8
		"E": "Alfred",
9
		"G": "Becker"
10
	}, {
11
		"_upsert": true,
12
		"_id": 44,
13
		"E": "Caroline",
14
		"G": "Schultz"
15
	}, {
16
		"_upsert": true,
17
		"_id": 45,
18
		"E": "Hans",
19
		"G": "Copeland"
20
	}]'
Use the upsert database operation when you need to update a single record or multiple records of the same record ID. This is especially useful when multiple tables are related to each other.
For example, upsert allows you to sync changes between multiple tables while maintaining the record IDs:
1.​Get changes in a table with sequence number from a source table.
2.Apply those changes to a target table with Upsert (update/insert) multiple records with POST.
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/changes?sinceSq={sequence}
Get changes in a database with sequence number
Sample request
1
curl https://anastasiya.ninoxdb.de/v1/teams/c1w72a5wl28zzmpn9/databases/k6lj89vm8vsl/changes?sinceSq=1
2
-X GET
3
-H "Authorization": "Bearer 90472720-5244-11ee-966b-d50b6af8825c"
4
-H "Content-Type": "application/json"
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/changes?sinceSq={sequence}
Get changes in a table with sequence number
Sample request
1
curl https://anastasiya.ninoxdb.de/v1/teams/c1w72a5wl28zzmpn9/databases/qjheo7dnp4fk/tables/A/changes?sinceSq=1
2
-X GET
3
-H "Authorization": "Bearer 90472720-5244-11ee-966b-d50b6af8825c"
4
-H "Content-Type": "application/json"
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/changes?sinceSq={sequence}
Get changes in a single record with sequence number
Sample request
1
curl https://anastasiya.ninoxdb.de/v1/teams/c1w72a5wl28zzmpn9/databases/m8u2w3ulmgt3/tables/A/records/8/changes?sinceSq=1
2
-X GET
3
-H "Authorization": "Bearer 90472720-5244-11ee-966b-d50b6af8825c"
4
-H "Content-Type": "application/json"
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"
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]'
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"
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 'file=@"/Users/anastasiya/Downloads/iStock-184877012.jpeg"'
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"
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"
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"
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"
​
get
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share
Get a share link of a single file
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"
​
post
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share
Create/update a share link of a single file with POST
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"
​
delete
https://{private-cloud}.ninoxdb.de
/v1/teams/{teamid}/databases/{dbid}/tables{tid}/records/{rid}/files/{file}/share
Delete a share link of a single file
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"
​
API - Previous
API calls in Ninox script
Next - API
Public Cloud APIs
Last modified 2mo ago