Stargate Document API reference

Table of Contents
Abstract
The Stargate REST API provides CRUD operations on table data managed by Stargate.

1. Endpoints

1.1. Auth

1.1.1. v1AuthPost

POST /v1/auth

Create an auth token

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Credentials

Credentials

X
Query Parameters
Name Description Required Default Pattern

pretty

format results

-

null
Return Type

-

Content Type

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

201

Created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.2. Keyspaces

1.2.1. v2KeyspacesKeyspaceIdTableIdGet

GET /v2/keyspaces/{keyspace-id}/{table-id}

search a table

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Header Parameters
Name Description Required Default Pattern

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

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
Return Type

-

Content Type

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.2.2. v2KeyspacesKeyspaceIdTableIdPost

POST /v2/keyspaces/{keyspace-id}/{table-id}

add a new row

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 3. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.2.3. v2KeyspacesKeyspaceIdTableIdPrimaryKeyDelete

DELETE /v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}

delete a row(s)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.2.4. v2KeyspacesKeyspaceIdTableIdPrimaryKeyGet

GET /v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}

get a row(s)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.2.5. v2KeyspacesKeyspaceIdTableIdPrimaryKeyPatch

PATCH /v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}

update part of a row(s)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.2.6. v2KeyspacesKeyspaceIdTableIdPrimaryKeyPut

PUT /v2/keyspaces/{keyspace-id}/{table-id}/{primary-key}

replace a row(s)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3. Namespaces

1.3.1. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDelete

DELETE /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}

delete a document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3.2. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathDelete

DELETE /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}

delete a sub document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 9. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3.3. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathGet

GET /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}

get a sub document by path

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 10. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.3.4. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPatch

PATCH /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}

update part of a sub document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 11. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.3.5. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdDocumentPathPut

PUT /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}/{document-path}

replace a sub document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3.6. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdGet

GET /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}

get a document by id

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.3.7. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPatch

PATCH /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}

update part of a document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.3.8. v2NamespacesNamespaceIdCollectionsCollectionIdDocumentIdPut

PUT /v2/namespaces/{namespace-id}/collections/{collection-id}/{document-id}

replace a document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 15. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3.9. v2NamespacesNamespaceIdCollectionsCollectionIdGet

GET /v2/namespaces/{namespace-id}/collections/{collection-id}

search for documents in {collection-id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null

collection-id

name of the document collection

X

null
Header Parameters
Name Description Required Default Pattern

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

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
Return Type

-

Content Type

  • application/json

Responses
Table 16. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.3.10. v2NamespacesNamespaceIdCollectionsCollectionIdPost

POST /v2/namespaces/{namespace-id}/collections/{collection-id}

add a new document to {collection-id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 17. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4. Schemas

1.4.1. v2SchemasKeyspacesGet

GET /v2/schemas/keyspaces

list keyspaces

Description
Parameters
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 18. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.2. v2SchemasKeyspacesKeyspaceIdDelete

DELETE /v2/schemas/keyspaces/{keyspace-id}

delete a keyspace

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 19. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.3. v2SchemasKeyspacesKeyspaceIdGet

GET /v2/schemas/keyspaces/{keyspace-id}

get a keyspace

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 20. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.4. v2SchemasKeyspacesKeyspaceIdTablesGet

GET /v2/schemas/keyspaces/{keyspace-id}/tables

list tables

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 21. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.5. v2SchemasKeyspacesKeyspaceIdTablesPost

POST /v2/schemas/keyspaces/{keyspace-id}/tables

create a table

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 22. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.6. v2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdDelete

DELETE /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}

delete a column

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 23. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.7. v2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdGet

GET /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}

get a column

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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-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
Return Type

-

Content Type

  • application/json

Responses
Table 24. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.8. v2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsColumnIdPut

PUT /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}

replace a column definition

Description
Parameters
Path Parameters
Name Description Required Default Pattern

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

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 25. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.9. v2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsGet

GET /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns

list columns

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 26. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.10. v2SchemasKeyspacesKeyspaceIdTablesTableIdColumnsPost

POST /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns

create a column

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 27. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.11. v2SchemasKeyspacesKeyspaceIdTablesTableIdDelete

DELETE /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}

delete a table

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 28. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.12. v2SchemasKeyspacesKeyspaceIdTablesTableIdGet

GET /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}

get a table

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 29. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.13. v2SchemasKeyspacesKeyspaceIdTablesTableIdPut

PUT /v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}

replace a table definition, except for columns

Description
Parameters
Path Parameters
Name Description Required Default Pattern

keyspace-id

keyspace name

X

null

table-id

table name

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 30. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.14. v2SchemasKeyspacesPost

POST /v2/schemas/keyspaces

create a keyspace

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 31. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.15. v2SchemasNamespacesGet

GET /v2/schemas/namespaces

list namespaces

Description
Parameters
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 32. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.16. v2SchemasNamespacesNamespaceIdCollectionsCollectionIdDelete

DELETE /v2/schemas/namespaces/{namespace-id}/collections/{collection-id}

delete a collection

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null

collection-id

name of the document collection

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 33. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.17. v2SchemasNamespacesNamespaceIdCollectionsCollectionIdGet

GET /v2/schemas/namespaces/{namespace-id}/collections/{collection-id}

get a collection

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null

collection-id

name of the document collection

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 34. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.18. v2SchemasNamespacesNamespaceIdCollectionsCollectionIdPut

PUT /v2/schemas/namespaces/{namespace-id}/collections/{collection-id}

update (replace) a collection

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null

collection-id

name of the document collection

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 35. http response codes
Code Message Datatype

200

resource updated

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.19. v2SchemasNamespacesNamespaceIdCollectionsGet

GET /v2/schemas/namespaces/{namespace-id}/collections

list collections in a namespace

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 36. http response codes
Code Message Datatype

200

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.20. v2SchemasNamespacesNamespaceIdCollectionsPost

POST /v2/schemas/namespaces/{namespace-id}/collections

create a collection

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 37. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

1.4.21. v2SchemasNamespacesNamespaceIdDelete

DELETE /v2/schemas/namespaces/{namespace-id}

delete a namespace

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 38. http response codes
Code Message Datatype

204

resource deleted

<<>>

401

Unauthorized

<<>>

500

Internal server error

<<>>
Samples

1.4.22. v2SchemasNamespacesNamespaceIdGet

GET /v2/schemas/namespaces/{namespace-id}

get a namespace

Description
Parameters
Path Parameters
Name Description Required Default Pattern

namespace-id

namespace name

X

null
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 39. http response codes
Code Message Datatype

200

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

404

Not Found

<<>>

500

Internal server error

<<>>
Samples

1.4.23. v2SchemasNamespacesPost

POST /v2/schemas/namespaces

create a namespace

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Header Parameters
Name Description Required Default Pattern

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
Return Type

-

Content Type

  • application/json

Responses
Table 40. http response codes
Code Message Datatype

201

resource created

<<>>

400

Invalid input

<<>>

401

Unauthorized

<<>>

409

Conflict

<<>>

500

Internal server error

<<>>
Samples

2. Models

2.1. Credentials

User credentials for authenticating

Field Name Required Type Description Format

username

X

String

Username

password

X

String

Password