POST

Get Capabilities


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Lists the global capabilities the external database supports.

Endpoint
POST
{DEPLOYMENT-URI}/v3/capabilities/get
Request
This endpoint does not take any parameters.
Response Object
supportsCollectionModificationsboolean

Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them.


supportedFieldTypesArray <string>

Field types the external database supports. This field only applies when supportsCollectionModifications is true.

Get the capabilities of the specified collection
Request
cURL
curl POST https://external-db.example.com/v3/capabilities/get \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' \ --d '{ }'
Response
JSON
{ "supportsCollectionModifications": true, "supportedFieldTypes": ["TEXT", "DATETIME", "NUMBER", "BOOLEAN"] }
Did this help?