admin5

apikeys6

apps7

authproviders7

billing2

custom-user-data2

data-api4

dependencies1

deploy13

email3

endpoints5

environments6

event-subscriptions3

functions7

graphql10

hosting7

log_forwarders7

logs1

metrics1

notifications7

rules9

schemas8

secrets4

security15

services11

sync2

triggers6

users12

values5

webhooks5

data-api

Enable the Data API

Changed on Feb 20, 2024

Create your app's Data API configuration.

post/groups/{groupId}/apps/{appId}/data_api/config

Request

Base URL
https://services.cloud.mongodb.com/api/admin/v3.0
URL
https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config
Auth
HTTP bearer

Request body

disabledboolean required

versionsDataApiVersion[] required

return_type'JSON' | 'EJSON' required

A data format supported by the Data API & custom endpoints.

create_user_on_authboolean

run_as_user_idstring

An application user's account ID. If defined, endpoints will always run as the specified user.

run_as_user_id_script_sourcestring

Stringified source code for a function that returns an application user's account ID. If defined, endpoints execute the function on every request and run as the user with the ID returned from the function.

validation_method'NO_VALIDATION' | 'SECRET_AS_QUERY_PARAM' | 'VERIFY_PAYLOAD' required

secret_namestring

If validation_method is set to "SECRET_AS_QUERY_PARAM" or "VERIFY_PAYLOAD", this is the name of the Secret that authorizes requests.

can_evaluateobject

A JSON expression that evaluates to true if an endpoint is allowed to run in response to an incoming request.

Response

Created