endpoints

Create an endpoint

Changed on

Create a new endpoint.

post/groups/{groupId}/apps/{appId}/endpoints

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}/endpoints
  • Auth
    HTTP bearer

Request body

routestring required
http_method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | '*' required
function_idstring required

The endpoint function's unique ID.

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

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

return_type'JSON' | 'EJSON' required

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

respond_resultboolean required
fetch_custom_user_databoolean
create_user_on_authboolean
disabledboolean required
_idstring

The endpoint's unique ID.

Response

Created

routestring required
http_method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | '*' required
function_idstring required

The endpoint function's unique ID.

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

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

return_type'JSON' | 'EJSON' required

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

respond_resultboolean required
fetch_custom_user_databoolean
create_user_on_authboolean
disabledboolean required
_idstring

The endpoint's unique ID.

function_namestring

Changes

  • v3e2240dd053bdRevision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      removed the required property //// from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added subschema #2 to the /// response property allOf list for the response status

  • v3eb671cf4e125Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property //// from the response with the status