Modificar um endpoint

COLOCAR /groups/{groupId}/apps/{appId}/endpoints/{endpointId}

Modifique uma configuração de ponto de extremidade existente.

parâmetros de caminho

aplicação/json

corpo, corpo Obrigatório

Um objeto de configuração válido e atualizado para o ponto de extremidade.

  • route string Obrigatório
  • http_method string Obrigatório

    Os valores são GET, POST, PUT, PATCH, DELETE ou *.

  • function_id string Obrigatório

    O ID único da função do ponto de extremidade.

  • validation_method string Obrigatório

    Os valores são NO_VALIDATION, SECRET_AS_QUERY_PARAM ou VERIFY_PAYLOAD.

  • secret_id string

    Se validation_method estiver definido como "SECRET_AS_QUERY_PARAM" ou "VERIFY_PAYLOAD", este é o _id do Segredo que autoriza as solicitações.

  • return_type string Obrigatório

    Um formato de dados compatível com a Data API e endpoints personalizados.

    Os valores são JSON ou EJSON.

  • respond_result booleano Obrigatório
  • fetch_custom_user_data booleano
  • create_user_on_auth booleano
  • desabilitado booleano Obrigatório
  • _id string

    O ID único do ponto de extremidade.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • route string Obrigatório
    • http_method string Obrigatório

      Os valores são GET, POST, PUT, PATCH, DELETE ou *.

    • function_id string Obrigatório

      O ID único da função do ponto de extremidade.

    • validation_method string Obrigatório

      Os valores são NO_VALIDATION, SECRET_AS_QUERY_PARAM ou VERIFY_PAYLOAD.

    • secret_id string

      Se validation_method estiver definido como "SECRET_AS_QUERY_PARAM" ou "VERIFY_PAYLOAD", este é o _id do Segredo que autoriza as solicitações.

    • return_type string Obrigatório

      Um formato de dados compatível com a Data API e endpoints personalizados.

      Os valores são JSON ou EJSON.

    • respond_result booleano Obrigatório
    • fetch_custom_user_data booleano
    • create_user_on_auth booleano
    • desabilitado booleano Obrigatório
    • _id string

      O ID único do ponto de extremidade.

    • function_name string
PUT /groups/{groupId}/apps/{appId}/endpoints/{endpointId}
curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/endpoints/{endpointId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"route":"string","http_method":"GET","function_id":"string","validation_method":"NO_VALIDATION","secret_id":"string","return_type":"JSON","respond_result":true,"fetch_custom_user_data":true,"create_user_on_auth":true,"disabled":true,"_id":"string"}'
Exemplos de solicitação
{
  "route": "string",
  "http_method": "GET",
  "function_id": "string",
  "validation_method": "NO_VALIDATION",
  "secret_id": "string",
  "return_type": "JSON",
  "respond_result": true,
  "fetch_custom_user_data": true,
  "create_user_on_auth": true,
  "disabled": true,
  "_id": "string"
}
Exemplos de resposta (200)
{
  "route": "string",
  "http_method": "GET",
  "function_id": "string",
  "validation_method": "NO_VALIDATION",
  "secret_id": "string",
  "return_type": "JSON",
  "respond_result": true,
  "fetch_custom_user_data": true,
  "create_user_on_auth": true,
  "disabled": true,
  "_id": "string",
  "function_name": "string"
}