Download OpenAPI specification:Download
The Stargate Document API provides CRUD operations on document data managed by Stargate.
Create an authorization token.
pretty | boolean format results |
username required | string Username |
password required | string Password |
{- "username": "string",
- "password": "string"
}
{- "authToken": "string"
}
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
A map representing a namespace with SimpleStrategy or NetworkTopologyStrategy with default replicas of 1 and 3 respectively Simple:
{ "name": "killrvideo", "replicas": 1 }
Network Topology:
{
"name": "killrvideo",
"datacenters":
[
{ "name": "dc1", "replicas": 3 },
{ "name": "dc2", "replicas": 3 },
],
}
{- "name": "killrvideo"
}
{- "name": "killrvideo"
}
Retrieve all available namespaces.
pretty | boolean format results |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "data": [
- {
- "name": "killrvideo",
- "datacenters": [
- {
- "name": "dc1",
- "replicas": 3
}, - {
- "name": "dc2",
- "replicas": 3
}
]
}
]
}
namespace-id required | string namespace name |
pretty | boolean format results |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "data": {
- "name": "killrvideo",
- "datacenters": [
- {
- "name": "dc1",
- "replicas": 3
}, - {
- "name": "dc2",
- "replicas": 3
}
]
}
}
namespace-id required | string namespace name |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{ }
namespace-id required | string namespace name |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "name": "users",
- "fields": {
- "name": {
- "type": "String",
- "index": true
}
}, - "validationAction": "warn"
}
{- "name": "killrvideo"
}
namespace-id required | string namespace name |
pretty | boolean format results |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "data": [
- {
- "name": "users",
- "fields": {
- "name": {
- "type": "String",
- "index": true
}
}, - "validationAction": "warn"
}
]
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
pretty | boolean format results |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "data": [
- {
- "name": "users",
- "fields": {
- "name": {
- "type": "String",
- "index": true
}
}, - "validationAction": "warn"
}
]
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{ }
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
pretty | boolean format results | ||||||||||||||||
where | object Examples:
URL escaped JSON query using the following keys:
| ||||||||||||||||
fields | string Examples:
URL escaped, comma delimited list of keys to include | ||||||||||||||||
page-size | integer <int32> Examples:
restrict the number of returned items (max 100) | ||||||||||||||||
page-state | string Examples:
move the cursor to a particular result | ||||||||||||||||
sort | object Examples:
keys to sort by | ||||||||||||||||
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "count": 1,
- "pageState": "2f4acd34",
- "data": [
- {
- "documentId": "my-first-post-a6h54",
- "title": "Hello World",
- "author": {
- "name": "Cliff Wicklow"
}
}
]
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
document
{- "title": "Hello World",
- "author": {
- "name": "CRW",
- "social": {
- "foo-bar-789": {
- "followers": 1,
- "likes": 7
}
}
}
}
{- "documentId": "e73c77ec-002d-457a-8b65-8ce7cfb15fc7"
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
pretty | boolean format results |
fields | string Examples:
URL escaped, comma delimited list of keys to include |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "data": {
- "documentId": "my-first-post-a6h54",
- "title": "Hello World",
- "author": {
- "name": "Cliff Wicklow"
}
}
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
document
{- "title": "Hello World",
- "author": {
- "name": "DKG"
}
}
{- "documentId": "e73c77ec-002d-457a-8b65-8ce7cfb15fc7"
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
document
{- "title": "Hello World"
}
{- "documentId": "e73c77ec-002d-457a-8b65-8ce7cfb15fc7"
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{ }
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
document-path required | string a JSON path |
pretty | boolean format results |
fields | string Examples:
URL escaped, comma delimited list of keys to include |
raw | boolean unwrap results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{- "documentPath": "author",
- "data": {
- "name": "Cliff Wicklow"
}
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
document-path required | string a JSON path |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
document
{- "foo-bar-789": {
- "followers": 1,
- "likes": 7
}
}
{- "documentId": "e73c77ec-002d-457a-8b65-8ce7cfb15fc7"
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
document-path required | string a JSON path |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
document
{- "title": "Hello World"
}
{- "documentId": "e73c77ec-002d-457a-8b65-8ce7cfb15fc7"
}
namespace-id required | string namespace name |
collection-id required | string name of the document collection |
document-id required | string the id of the document |
document-path required | string a JSON path |
pretty | boolean format results |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
{ }