endpoints

Get an endpoint

Get a specific endpoint's configuration.

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

Response

routestring 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

Changed in 3 of the 50 revisions of this API.4202

Feb 20, 2024v3e2240dd053bd291See the full diff
- ▲
  the allOf[Endpoint]/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property allOf[Endpoint]/function_id from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property allOf[Endpoint]/create_user_on_auth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/disabled from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/fetch_custom_user_data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/http_method from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/respond_result from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/return_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/route from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/secret_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[Endpoint]/validation_method from the response with the 200 status
  response-optional-property-removed
- ○
  added BaseEndpoint subschema #2 to the allOf[Endpoint]/ response property allOf list for the response status 200
  response-property-all-of-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 31, 2023v3eb671cf4e1251See the full diff
- ●
  removed the optional property allOf[Endpoint]/function_name from the response with the 200 status
  response-optional-property-removed
Mar 27, 2023v3c75e1135f5d42101See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ▲
  removed the required property function_id from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property create_user_on_auth from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property disabled from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property fetch_custom_user_data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property function_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property http_method from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property respond_result from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property return_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property route from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property secret_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property validation_method from the response with the 200 status
  response-optional-property-removed
- ○
  added Endpoint subschema #2 to the response body allOf list for the response status 200
  response-body-all-of-added

Full history