Function ServicesApiAxiosParamCreator

Returns {
    adminCreateService: ((groupId, appId, body?, options?) => Promise<RequestArgs>);
    adminDeleteService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminGenerateSchema: ((groupId, appId, serviceId, adminGenerateSchemaRequest, options?) => Promise<RequestArgs>);
    adminGetService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminGetServiceConfig: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminListServices: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminRunCommand: ((groupId, appId, serviceId, commandName, options?) => Promise<RequestArgs>);
    adminUpdateService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminUpdateServiceConfig: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    getBuildInfo: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
}

• adminCreateService: ((groupId, appId, body?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, body?, options?): Promise<RequestArgs>

    • Create a data source or third-party service [Deprecated].

      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 body: any

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a data source or third-party service

      Throws

• adminDeleteService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Delete a data source or third-party service [Deprecated].

      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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a data source or third-party service

      Throws

• adminGenerateSchema: ((groupId, appId, serviceId, adminGenerateSchemaRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, adminGenerateSchemaRequest, options?): Promise<RequestArgs>

    • Sample a subset of documents in a collection to generate a JSON schema.

      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.

      • serviceId: any

        The unique `_id` value of a service.

      • adminGenerateSchemaRequest: AdminGenerateSchemaRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Generate a JSON schema from sample

      Throws

• adminGetService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Get a data source or third-party service [Deprecated].

      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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a data source or third-party service

      Throws

• adminGetServiceConfig: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Retrieve a service'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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Retrieve a service's configuration

      Throws

• adminListServices: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • List all data sources and third-party services [Deprecated].

      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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List all data sources and third-party services

      Throws

• adminRunCommand: ((groupId, appId, serviceId, commandName, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, commandName, options?): Promise<RequestArgs>

    • Run a command associated with a service.

      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.

      • serviceId: any

        The unique `_id` value of a service.

      • commandName: any

        Command name

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Run a command associated with a service

      Throws

• adminUpdateService: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Update a service.

      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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update a service

      Throws

• adminUpdateServiceConfig: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Update a service'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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update a service's configuration

      Throws

• getBuildInfo: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • 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.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get information about the underlying Atlas mongod

      Throws