Skip to content

Update Datastore ​

Partially updates a datastore record by ID. Only fields in the request body will be updated.

Endpoint ​

http
PATCH /datastore/{id}

Path parameters ​

id
string · uuid
REQUIRED · 

The ID of the datastore to update.

Request Body ​

label
string

New label for this datastore.

config

Updated config object. Partial updates are accepted; fields not supplied are left unchanged. Shape still depends on type.

config_secret
string

New secret credentials if needed.

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.