Stargate Document API reference

auth
- Create an auth tokenpost
namespaces
keyspaces
schemas

Stargate REST API reference

auth
- Create an authorization tokenpost
schemas
data

Astra DevOps API

Using the Astra DevOps API
Authentication
- Create a token to use the Astra DevOps API endpointspost
Operations

Stargate Document API reference

auth
- Create an auth tokenpost
namespaces
keyspaces
schemas

Stargate REST API reference

auth
- Create an authorization tokenpost
schemas
data

Astra DevOps API

Using the Astra DevOps API
Authentication
- Create a token to use the Astra DevOps API endpointspost
Operations

Get a column

get https://{databaseId}-{region}.apps.astra.datastax.com/api/rest/v2/schemas/keyspaces/{keyspace-id}/tables/{table-id}/columns/{column-id}

URL Expired

The URL for this request expired after 30 days.

Path Params

databaseId

string

required

UUID of your database from the Astra URL.
For example, d341f349-e5db-46d2-9c90-bb9ebaa6f0fc.

region

string

required

Cloud region where your database lives.
For example, us-east-1

keyspace-id

string

required

keyspace name

table-id

string

required

table name

column-id

string

required

column name

Query Params

raw

boolean

Defaults to false

unwrap results

Headers

X-Cassandra-Token

string

required

The token returned from the authorization endpoint. Use this token in each request.

Responses

Response body

object

name

string

required

Name for the column, which must be unique.

typeDefinition

string

required

The type of data allowed in the column.

ascii text varchar tinyint smallint int bigint varint decimal float double date DateRangeType duration time timestamp uuid timeuuid blob boolean counter inet PointType LineStringType PolygonType frozen list map set tuple

static

boolean

Defaults to false

Denotes whether the column is shared by all rows of a partition.

Response body

object

description

string

A human readable description of the error state

code

integer

The code referencing the error state

Response body

object

description

string

A human readable description of the error state

code

integer

The code referencing the error state

Response body

object

description

string

A human readable description of the error state

code

integer

The code referencing the error state

Updated over 4 years ago

Create a column

Replace a column definition

Did this page help you?

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://databaseid-region.apps.astra.datastax.com/api/rest/v2/schemas/keyspaces/keyspace-id/tables/table-id/columns/column-id?raw=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

Updated over 4 years ago

Create a column

Replace a column definition

Did this page help you?

Stargate Document API reference
auth
Create an auth tokenpost
namespaces
delete a sub documentdelete
update part of a sub documentpatch
replace a sub documentput
get a sub document by pathget
delete a documentdelete
update part of a documentpatch
replace a documentput
get a document by idget
add a new document to {collection-id}post
search for documents in {collection-id}get
keyspaces
delete a row(s)delete
update part of a row(s)patch
replace a row(s)put
get a row(s)get
add a new rowpost
search a tableget
schemas
delete a collectiondelete
get a collectionget
create a collectionpost
list collections in a namespaceget
delete a namespacedelete
get a namespaceget
create a namespacepost
list namespacesget
delete a columndelete
replace a column definitionput
get a columnget
create a columnpost
list columnsget
delete a tabledelete
replace a table definition, except for columnsput
get a tableget
create a tablepost
list tablesget
get a keyspaceget
list keyspacesget

Stargate REST API reference
auth
Create an authorization tokenpost
schemas
Delete a columndelete
Replace a column definitionput
Get a columnget
Create a columnpost
List columnsget
Delete a tabledelete
Replace a table definition, except for columnsput
get a tableget
create a tablepost
list tablesget
Get a keyspaceget
Return all keyspacesget
data
delete a row(s)delete
Update part of a rowpatch
Replace a rowput
Get a rowget
Add rowspost
Search a tableget

Astra DevOps API
Using the Astra DevOps API
Authentication
Create a token to use the Astra DevOps API endpointspost
Operations
Returns supported regions and availability for a given user / orgget
Resets Passwordpost
Resizes a databasepost
Unparks a databasepost
Parks a databasepost
Terminates a databasepost
Obtain zip for connecting to the databasepost
Adds keyspace into databasepost
Finds database by IDget
Create a new databasepost
Returns a list of databasesget

Stargate Document API reference
auth
Create an auth tokenpost
namespaces
delete a sub documentdelete
update part of a sub documentpatch
replace a sub documentput
get a sub document by pathget
delete a documentdelete
update part of a documentpatch
replace a documentput
get a document by idget
add a new document to {collection-id}post
search for documents in {collection-id}get
keyspaces
delete a row(s)delete
update part of a row(s)patch
replace a row(s)put
get a row(s)get
add a new rowpost
search a tableget
schemas
delete a collectiondelete
get a collectionget
create a collectionpost
list collections in a namespaceget
delete a namespacedelete
get a namespaceget
create a namespacepost
list namespacesget
delete a columndelete
replace a column definitionput
get a columnget
create a columnpost
list columnsget
delete a tabledelete
replace a table definition, except for columnsput
get a tableget
create a tablepost
list tablesget
get a keyspaceget
list keyspacesget

Stargate REST API reference
auth
Create an authorization tokenpost
schemas
Delete a columndelete
Replace a column definitionput
Get a columnget
Create a columnpost
List columnsget
Delete a tabledelete
Replace a table definition, except for columnsput
get a tableget
create a tablepost
list tablesget
Get a keyspaceget
Return all keyspacesget
data
delete a row(s)delete
Update part of a rowpatch
Replace a rowput
Get a rowget
Add rowspost
Search a tableget

Astra DevOps API
Using the Astra DevOps API
Authentication
Create a token to use the Astra DevOps API endpointspost
Operations
Returns supported regions and availability for a given user / orgget
Resets Passwordpost
Resizes a databasepost
Unparks a databasepost
Parks a databasepost
Terminates a databasepost
Obtain zip for connecting to the databasepost
Adds keyspace into databasepost
Finds database by IDget
Create a new databasepost
Returns a list of databasesget

200

401Unauthorized

404Not Found

500Internal server error