Appearance

Create Datastore ​

Creates a new datastore record. The environment_id must be one the user has permission to access.

Endpoint ​

http
POST /datastore

Request Body ​

id
string · uuid

The datastore ID (optional; if omitted, one is generated).

type
string

The datastore type. Determines the shape of config.

All possible enum values:
  • mongo_data_api
  • google_cloud_storage
  • s3
  • qdrant
label
string

A friendly label for this datastore.

config

Config object for the datastore connection. Shape depends on type.

config_secret
string

Optional secret value for sensitive credentials.

environment_id
string · uuid

The environment that owns this datastore. If omitted, defaults to the user's first environment; required when the user has multiple environments.

validation_methods
string[]

Optional list of integration methods (e.g. unified_api/resource/method) used to validate the datastore configuration before persisting.

Response Body ​

id
string · uuid

The unique ID of the datastore.

type
string

The datastore's backend type. Determines the shape of config.

All possible enum values:
  • mongo_data_api
  • google_cloud_storage
  • s3
  • qdrant
label
string

A friendly label for identifying this datastore.

config

Config object for the datastore connection (minus sensitive fields). The shape depends on type.

Example: { "base_url": "https://data.mongodb-api.com/app/...", "database": "my_db" }
environment_id
string · uuid

The environment to which this datastore belongs.

created_at
string · date-time

Timestamp when the datastore record was created.

updated_at
string · date-time

Timestamp when the datastore record was last updated.