Obtener la configuración de la API de datos | Documentación de la API de administración de servicios de aplicaciones de MongoDB Atlas 3.0

Obtener la configuración de la API de datos Obsoleto

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

Autorización de token

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

Parámetros de ruta

ID de grupo string Requerido

Un ID de proyecto/grupo Atlas.
ID de aplicación 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
  
  Una versión compatible de la API de datos.
  
  El valor es v1.
- return_type string Requerido
  
  Un formato de datos compatible con la API de datos y puntos finales personalizados.
  
  Los valores son JSON o EJSON.
- crear_usuario_en_auth booleano
- ejecutar como id de usuario string
  
  ID de cuenta de un usuario de la aplicación. Si se define, los endpoints siempre se ejecutarán con el usuario especificado.
- ejecutar_como_id_de_usuario_script_source string
  
  Código fuente en cadena para una función que devuelve el ID de la 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 devuelto por la función.
- método de validación string Requerido
  
  Los valores son NO_VALIDATION, SECRET_AS_QUERY_PARAM o VERIFY_PAYLOAD.
- nombre_secreto string
  
  Si validation_method está establecido en "SECRET_AS_QUERY_PARAM" o "VERIFY_PAYLOAD", este es el name del Secreto que autoriza las solicitudes.
- puede_evaluar 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.

OBTENER /grupos/{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": {}
}