Stargate Document API reference (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

The Stargate Document API provides CRUD operations on document data managed by Stargate.

Auth

auth

Create an auth token

Create an authorization token.

query Parameters

pretty

boolean

format results

Request Body schema: application/json

username required	string Username
password required	string Password

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"authToken": "string"
}

Schemas

storage configuration

Create a namespace

query Parameters

pretty

boolean

format results

header Parameters

X-Cassandra-Token

required

string

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

Request Body schema: application/json

A map representing a namespace with SimpleStrategy or NetworkTopologyStrategy with default replicas of 1 and 3 respectively Simple:

{ "name": "killrvideo", "replicas": 1 }

Network Topology:

{
  "name": "killrvideo",
   "datacenters":
      [
         { "name": "dc1", "replicas": 3 },
         { "name": "dc2", "replicas": 3 },
      ],
}

object

Responses

Request samples

Payload

Content type

application/json

Example

{"name": "killrvideo"
}

Response samples

201
400
401
409
500

Content type

application/json

{"name": "killrvideo"
}

Get all namespaces

Retrieve all available namespaces.

query Parameters

pretty	boolean format results
raw	boolean unwrap results

header Parameters

X-Cassandra-Token

required

string

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

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"name": "killrvideo",
"datacenters": [{"name": "dc1",
"replicas": 3
},
{"name": "dc2",
"replicas": 3
}
]
}
]
}

Get a namespace

path Parameters

namespace-id

required

string

namespace name

query Parameters

pretty	boolean format results
raw	boolean unwrap results

header Parameters

X-Cassandra-Token

required

string

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

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"name": "killrvideo",
"datacenters": [{"name": "dc1",
"replicas": 3
},
{"name": "dc2",
"replicas": 3
}
]
}
}

Delete a namespace

path Parameters

namespace-id

required

string

namespace name

query Parameters

pretty

boolean

format results

header Parameters

X-Cassandra-Token

required

string

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

Responses

Response samples

204
401
500

Content type

application/json

{ }

Documents

document data

Create a collection

path Parameters

namespace-id

required

string

namespace name

query Parameters

pretty

boolean

format results

header Parameters

X-Cassandra-Token

required

string

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

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"name": "users",
"fields": {"name": {"type": "String",
"index": true
}
},
"validationAction": "warn"
}

Response samples

201
400
401
409
500

Content type

application/json

{"name": "killrvideo"
}

List collections in a namespace

path Parameters

namespace-id

required

string

namespace name

query Parameters

pretty	boolean format results
raw	boolean unwrap results

header Parameters

X-Cassandra-Token

required

string

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

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"name": "users",
"fields": {"name": {"type": "String",
"index": true
}
},
"validationAction": "warn"
}
]
}

Get a collection

path Parameters

namespace-id

required