Function EndpointsApiFactory

Returns {
    adminCreateEndpoint(groupId, appId, endpoint, options?) => AxiosPromise<any>;
    adminDeleteEndpoint(groupId, appId, endpointId, options?) => AxiosPromise<any>;
    adminGetAllEndpoints(groupId, appId, options?) => AxiosPromise<any>;
    adminGetEndpoint(groupId, appId, endpointId, options?) => AxiosPromise<any>;
    adminModifyEndpoint(groupId, appId, endpointId, endpoint, options?) => AxiosPromise<any>;
}

• adminCreateEndpoint:function

  • adminCreateEndpoint(groupId, appId, endpoint, options?): AxiosPromise<any>

  • Create a new endpoint.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • endpoint: Endpoint

      A valid configuration object for the new endpoint.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Create an endpoint

    Throws

• adminDeleteEndpoint:function

  • adminDeleteEndpoint(groupId, appId, endpointId, options?): AxiosPromise<any>

  • Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • endpointId: any

      The unique `_id` value of an endpoint

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Delete an endpoint

    Throws

• adminGetAllEndpoints:function

  • adminGetAllEndpoints(groupId, appId, options?): AxiosPromise<any>

  • Get all endpoint configurations.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Get all endpoints

    Throws

• adminGetEndpoint:function

  • adminGetEndpoint(groupId, appId, endpointId, options?): AxiosPromise<any>

  • Get a specific endpoint's configuration.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • endpointId: any

      The unique `_id` value of an endpoint

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Get an endpoint

    Throws

• adminModifyEndpoint:function

  • adminModifyEndpoint(groupId, appId, endpointId, endpoint, options?): AxiosPromise<any>

  • Modify an existing endpoint configuration.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • endpointId: any

      The unique `_id` value of an endpoint

    • endpoint: Endpoint

      A valid, updated configuration object for the endpoint.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    Modify an endpoint

    Throws