endpoints
Create an endpoint
Create a new endpoint.
post/groups/{groupId}/apps/{appId}/endpoints
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