API Reference
Log In
API Reference

get a sub document by path

get
https://{databaseId}-{region}.apps.astra.datastax.com/api/rest/v2/namespaces//collections///
Path Params
string
required

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

string
required

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

string
required

namespace name

string
required

name of the document collection

string
required

the id of the document

string
required

a JSON path

Query Params
boolean

format results

string

URL escaped, comma delimited list of keys to include

boolean

unwrap results

Headers
uuid
required

Unique identifier (UUID) for the request. Use any valid UUID.

string
required

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

Responses

Updated over 5 years ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 5 years ago