Stargate Document API reference
- 1. Endpoints
- 1.1. Auth
- 1.2. Keyspaces
- 1.2.1. apiRestV2KeyspacesKeyspaceIdTableIdGet
- 1.2.2. apiRestV2KeyspacesKeyspaceIdTableIdPost
- 1.2.3. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyDelete
- 1.2.4. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyGet
- 1.2.5. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyPatch
- 1.2.6. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyPut
- 1.3. Namespaces
- 1.3.1. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDelete
- 1.3.2. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathDelete
- 1.3.3. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathGet
- 1.3.4. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPatch
- 1.3.5. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPut
- 1.3.6. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdGet
- 1.3.7. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPatch
- 1.3.8. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPut
- 1.3.9. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdGet
- 1.3.10. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdPost
- 1.4. Schemas
- 1.4.1. apiRestV2NamespacesNamespaceIdCollectionsGet
- 1.4.2. apiRestV2NamespacesNamespaceIdCollectionsPost
- 1.4.3. apiRestV2SchemasKeyspacesGet
- 1.4.4. apiRestV2SchemasKeyspacesKeyspaceIdGet
- 1.4.5. apiRestV2SchemasKeyspacesKeyspaceIdTablesGet
- 1.4.6. apiRestV2SchemasKeyspacesKeyspaceIdTablesPost
- 1.4.7. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdDelete
- 1.4.8. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdGet
- 1.4.9. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdPut
- 1.4.10. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsGet
- 1.4.11. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsPost
- 1.4.12. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdDelete
- 1.4.13. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdGet
- 1.4.14. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdPut
- 1.4.15. apiRestV2SchemasNamespacesGet
- 1.4.16. apiRestV2SchemasNamespacesNamespaceIdCollectionsCollectionIdDelete
- 1.4.17. apiRestV2SchemasNamespacesNamespaceIdCollectionsCollectionIdGet
- 1.4.18. apiRestV2SchemasNamespacesNamespaceIdDelete
- 1.4.19. apiRestV2SchemasNamespacesNamespaceIdGet
- 1.4.20. apiRestV2SchemasNamespacesPost
- 2. Models
The Stargate REST API provides CRUD operations on table data managed by Stargate.
1. Endpoints
1.1. Auth
1.1.1. apiRestV1AuthPost
POST /api/rest/v1/auth
Create an auth token
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Credentials |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.2. Keyspaces
1.2.1. apiRestV2KeyspacesKeyspaceIdTableIdGet
GET /api/rest/v2/keyspaces/{keyspace-id}/{table-id}
search a table
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
where |
URL escaped JSON query using the following keys: |
Key |
Operation |
|
- |
- |
$lt |
Less Than |
|
$lte |
Less Than Or Equal To |
$gt |
||
Greater Than |
$gte |
Greater Than Or Equal To |
||
$ne |
Not Equal To |
$in |
Contained In |
|
$exists |
A value is set for the key |
$select |
||
This matches a value for a key in the result of a different query |
$dontSelect |
Requires that a key’s value not match a value for a key in the result of a different query |
||
$all |
Contains all of the given values |
$regex |
Requires that a key’s value match a regular expression |
|
$text |
Performs a full text search on indexed fields |
- |
||
null |
fields |
URL escaped, comma delimited list of keys to include |
- |
|
null |
page-size |
restrict the number of returned items (max 100) |
- |
|
null |
page-state |
move the cursor to a particular result |
- |
|
null |
sort |
keys to sort by |
- |
|
null |
raw |
unwrap results |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.2.2. apiRestV2KeyspacesKeyspaceIdTableIdPost
POST /api/rest/v2/keyspaces/{keyspace-id}/{table-id}
add a new row
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
row [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.2.3. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyDelete
DELETE /api/rest/v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}
delete a row(s)
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
primary-key |
Value from the primary key column for the table. Define composite keys by separating values with slashes (`val1/val2…`) in the order they were defined. </br> For example, if the composite key was defined as `PRIMARY KEY(race_year, race_name)` then the primary key in the path would be `race_year/race_name` |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.2.4. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyGet
GET /api/rest/v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}
get a row(s)
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
primary-key |
Value from the primary key column for the table. Define composite keys by separating values with slashes (`val1/val2…`) in the order they were defined. </br> For example, if the composite key was defined as `PRIMARY KEY(race_year, race_name)` then the primary key in the path would be `race_year/race_name` |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
fields |
URL escaped, comma delimited list of keys to include |
- |
null |
|
page-size |
restrict the number of returned items (max 100) |
- |
null |
|
page-state |
move the cursor to a particular result |
- |
null |
|
sort |
keys to sort by |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.2.5. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyPatch
PATCH /api/rest/v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}
update part of a row(s)
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
primary-key |
Value from the primary key column for the table. Define composite keys by separating values with slashes (`val1/val2…`) in the order they were defined. </br> For example, if the composite key was defined as `PRIMARY KEY(race_year, race_name)` then the primary key in the path would be `race_year/race_name` |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.2.6. apiRestV2KeyspacesKeyspaceIdTableIdPrimaryKeyPut
PUT /api/rest/v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}
replace a row(s)
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
primary-key |
Value from the primary key column for the table. Define composite keys by separating values with slashes (`val1/val2…`) in the order they were defined. </br> For example, if the composite key was defined as `PRIMARY KEY(race_year, race_name)` then the primary key in the path would be `race_year/race_name` |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3. Namespaces
1.3.1. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDelete
DELETE /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}
delete a document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3.2. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathDelete
DELETE /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}
delete a sub document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
|
document-path |
a JSON path |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3.3. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathGet
GET /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}
get a sub document by path
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
|
document-path |
a JSON path |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
fields |
URL escaped, comma delimited list of keys to include |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.3.4. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPatch
PATCH /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}
update part of a sub document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
|
document-path |
a JSON path |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.3.5. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPut
PUT /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}
replace a sub document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
|
document-path |
a JSON path |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3.6. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdGet
GET /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}
get a document by id
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
fields |
URL escaped, comma delimited list of keys to include |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.3.7. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPatch
PATCH /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}
update part of a document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.3.8. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPut
PUT /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}
replace a document
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
|
document-id |
the id of the document |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3.9. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdGet
GET /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}
search for documents in {collection-id}
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
where |
URL escaped JSON query using the following keys: |
Key |
Operation |
|
- |
- |
$lt |
Less Than |
|
$lte |
Less Than Or Equal To |
$gt |
||
Greater Than |
$gte |
Greater Than Or Equal To |
||
$ne |
Not Equal To |
$in |
Contained In |
|
$exists |
A value is set for the key |
$select |
||
This matches a value for a key in the result of a different query |
$dontSelect |
Requires that a key’s value not match a value for a key in the result of a different query |
||
$all |
Contains all of the given values |
$regex |
Requires that a key’s value match a regular expression |
|
$text |
Performs a full text search on indexed fields |
- |
||
null |
fields |
URL escaped, comma delimited list of keys to include |
- |
|
null |
page-size |
restrict the number of returned items (max 100) |
- |
|
null |
page-state |
move the cursor to a particular result |
- |
|
null |
sort |
keys to sort by |
- |
|
null |
raw |
unwrap results |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.3.10. apiRestV2NamespacesNamespaceIdCollectionsCollectionIdPost
POST /api/rest/v2/namespaces/{namespace-id}/collections/{collection-id}
add a new document to {collection-id}
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
document [object] |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4. Schemas
1.4.1. apiRestV2NamespacesNamespaceIdCollectionsGet
GET /api/rest/v2/namespaces/{namespace-id}/collections
list collections in a namespace
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.2. apiRestV2NamespacesNamespaceIdCollectionsPost
POST /api/rest/v2/namespaces/{namespace-id}/collections
create a collection
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4.3. apiRestV2SchemasKeyspacesGet
GET /api/rest/v2/schemas/keyspaces
list keyspaces
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.4. apiRestV2SchemasKeyspacesKeyspaceIdGet
GET /api/rest/v2/schemas/keyspaces/{keyspace-id}
get a keyspace
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.5. apiRestV2SchemasKeyspacesKeyspaceIdTablesGet
GET /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables
list tables
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.6. apiRestV2SchemasKeyspacesKeyspaceIdTablesPost
POST /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables
create a table
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4.7. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdDelete
DELETE /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}
delete a column
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
column-id |
column name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.8. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdGet
GET /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}
get a column
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
column-id |
column name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.9. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdPut
PUT /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}
replace a column definition
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
|
column-id |
column name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4.10. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsGet
GET /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns
list columns
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.11. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsPost
POST /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns
create a column
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4.12. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdDelete
DELETE /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}
delete a table
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.13. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdGet
GET /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}
get a table
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.14. apiRestV2SchemasKeyspacesKeyspaceIdTablesTableIdPut
PUT /api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}
replace a table definition, except for columns
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
keyspace-id |
keyspace name |
X |
null |
|
table-id |
table name |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
resource updated |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
1.4.15. apiRestV2SchemasNamespacesGet
GET /api/rest/v2/schemas/namespaces
list namespaces
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.16. apiRestV2SchemasNamespacesNamespaceIdCollectionsCollectionIdDelete
DELETE /api/rest/v2/schemas/namespaces/{namespace-id}/collections/{collection-id}
delete a collection
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.17. apiRestV2SchemasNamespacesNamespaceIdCollectionsCollectionIdGet
GET /api/rest/v2/schemas/namespaces/{namespace-id}/collections/{collection-id}
get a collection
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
|
collection-id |
name of the document collection |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.18. apiRestV2SchemasNamespacesNamespaceIdDelete
DELETE /api/rest/v2/schemas/namespaces/{namespace-id}
delete a namespace
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
resource deleted |
<<>> |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
<<>> |
1.4.19. apiRestV2SchemasNamespacesNamespaceIdGet
GET /api/rest/v2/schemas/namespaces/{namespace-id}
get a namespace
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
|
namespace-id |
namespace name |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
|
raw |
unwrap results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
<<>> |
|
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
404 |
Not Found |
<<>> |
500 |
Internal server error |
<<>> |
1.4.20. apiRestV2SchemasNamespacesPost
POST /api/rest/v2/schemas/namespaces
create a namespace
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
databaseId |
UUID of your database from the Astra URL. </br> For example, `d341f349-e5db-46d2-9c90-bb9ebaa6f0fc`. |
X |
null |
|
region |
Cloud region where your database lives. </br> For example, `us-east-1` |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-Cassandra-Request-Id |
Unique identifier (UUID) for the request. Use any valid UUID. |
X |
null |
|
X-Cassandra-Token |
The token returned from the authorization endpoint. Use this token in each request to the database. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pretty |
format results |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
resource created |
<<>> |
400 |
Invalid input |
<<>> |
401 |
Unauthorized |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal server error |
<<>> |
2. Models
2.1. Credentials
User credentials for authenticating
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
username |
X |
String |
Username |
|
password |
X |
String |
Password |