Download OpenAPI specification:Download
The Stargate REST API provides CRUD operations on table data managed by Stargate.
Create an authorization token used for all queries.
username required | string Username |
password required | string Password |
{- "username": "string",
- "password": "string"
}
{- "authToken": "string"
}
Retrieve all available keyspaces in the specific database.
raw | boolean Default: false 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": "string",
- "datacenters": [
- {
- "name": "string",
- "replicas": 0
}
]
}
]
}
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
name required | string |
Array of objects (Datacenter) |
{- "name": "string",
- "datacenters": [
- {
- "name": "string",
- "replicas": 0
}
]
}
{- "name": "string"
}
keyspace-id required | string keyspace name |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
name required | string |
ifNotExists | boolean Default: false Determines whether to create a new table if a table with the same name exists. Attempting to create an existing table returns an error unless this option is true. |
required | Array of objects (ColumnDefinition) |
required | object (PrimaryKey) Defines a column list for the primary key. Can be either a single column, compound primary key, or composite partition key. Provide multiple columns for the partition key to define a composite partition key. |
object (TableOptions) |
{- "name": "string",
- "ifNotExists": false,
- "columnDefinitions": [
- {
- "name": "emailaddress",
- "typeDefinition": "text",
- "static": false
}
], - "primaryKey": {
- "partitionKey": [
- "string"
], - "clusteringKey": [
- "string"
]
}, - "tableOptions": {
- "defaultTimeToLive": 0,
- "clusteringExpression": [
- {
- "column": "string",
- "order": "ASC"
}
]
}
}
{- "name": "string"
}
keyspace-id required | string keyspace name |
raw | boolean Default: false 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": "string",
- "keyspace": "string",
- "columnDefinitions": [
- {
- "name": "emailaddress",
- "typeDefinition": "text",
- "static": false
}
], - "primaryKey": {
- "partitionKey": [
- "string"
], - "clusteringKey": [
- "string"
]
}, - "tableOptions": {
- "defaultTimeToLive": 0,
- "clusteringExpression": [
- {
- "column": "string",
- "order": "ASC"
}
]
}
}
]
}
keyspace-id required | string keyspace name |
table-id required | string table name |
X-Cassandra-Token required | string The token returned from the authorization endpoint for classic databases. Use this token in each request. |
name required | string |
ifNotExists | boolean Default: false Determines whether to create a new table if a table with the same name exists. Attempting to create an existing table returns an error unless this option is true. |
required | Array of objects (ColumnDefinition) |
required | object (PrimaryKey) Defines a column list for the primary key. Can be either a single column, compound primary key, or composite partition key. Provide multiple columns for the partition key to define a composite partition key. |
object (TableOptions) |
{- "name": "string",
- "ifNotExists": false,
- "columnDefinitions": [
- {
- "name": "emailaddress",
- "typeDefinition": "text",
- "static": false
}
], - "primaryKey": {
- "partitionKey": [
- "string"
], - "clusteringKey": [
- "string"
]
}, - "tableOptions": {
- "defaultTimeToLive": 0,
- "clusteringExpression": [