Obten la configuración de la API de datos | MongoDB Atlas App Services Admin API 3.0 documentation

Obten la configuración de la API de datos Obsoleto

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

Token auth

Obtén la configuración de la API de datos de tu aplicación.

Parámetros de path

ID del grupo string Requerido

An Atlas Project/Group ID.
appId string Requerido

El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.

Respuestas

200 aplicación/json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta objeto | nulo
- inhabilitado booleano Requerido
- versiones array[string] Requerido
  
  A supported version of the Data API.
  
  El valor es v1.
- return_type string Requerido
  
  A data format supported by the Data API & custom endpoints.
  
  Los valores son JSON o EJSON.
- create_user_on_auth booleano
- run_as_user_id string
  
  An application user's account ID. If defined, endpoints will always run as the specified user.
- run_as_user_id_script_source string
  
  Código fuente convertido en string para una función que retorna el ID de cuenta de un usuario de la aplicación. Si se define, los endpoints ejecutan la función en cada solicitud y se ejecutan como el usuario con el ID retornado por la función.
- método de validación string Requerido
  
  Los valores son NO_VALIDATION, SECRET_AS_QUERY_PARAM o VERIFY_PAYLOAD.
- secret_name string
  
  Si validation_method está establecido en "SECRET_AS_QUERY_PARAM" o "VERIFY_PAYLOAD", este es el name del Secreto que autoriza las solicitudes.
- can_evaluate Objeto
  
  Una expresión JSON que evalúa como true si se permite que un punto final se ejecute en respuesta a una solicitud entrante.

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

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Ejemplos de respuestas (200)

{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}