Skip to content

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 (e.g., mongo_data_api).

label
string

A friendly label for this datastore.

config
object

Config object for the datastore connection.

config_secret
string

Optional secret value for sensitive credentials.

Response Body ​

id
string · uuid

The unique ID of the datastore.

type
string

The datastore's backend type.

All possible enum values:
  • mongo_data_api
label
string

A friendly label for identifying this datastore.

config
object

Config object for the datastore connection (minus sensitive fields).

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.