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"
}
]
}