Function ServicesApiFp

Returns {
    adminCreateService(groupId, appId, body?, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminDeleteService(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGenerateSchema(groupId, appId, serviceId, adminGenerateSchemaRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<AdminGenerateSchema200Response>)>;
    adminGetService(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminGetServiceConfig(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminListServices(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminRunCommand(groupId, appId, serviceId, commandName, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminUpdateService(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminUpdateServiceConfig(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getBuildInfo(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<BuildInfo>)>;
}

• adminCreateService:function

  • adminCreateService(groupId, appId, body?, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Create a data source or third-party service

    Throws

• adminDeleteService:function

  • adminDeleteService(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a data source or third-party service

    Throws

• adminGenerateSchema:function

  • adminGenerateSchema(groupId, appId, serviceId, adminGenerateSchemaRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<AdminGenerateSchema200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<AdminGenerateSchema200Response>)>

    Summary

    Generate a JSON schema from sample

    Throws

• adminGetService:function

  • adminGetService(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get a data source or third-party service

    Throws

• adminGetServiceConfig:function

  • adminGetServiceConfig(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Retrieve a service's configuration

    Throws

• adminListServices:function

  • adminListServices(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List all data sources and third-party services

    Throws

• adminRunCommand:function

  • adminRunCommand(groupId, appId, serviceId, commandName, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Run a command associated with a service

    Throws

• adminUpdateService:function

  • adminUpdateService(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a service

    Throws

• adminUpdateServiceConfig:function

  • adminUpdateServiceConfig(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a service's configuration

    Throws

• getBuildInfo:function

  • getBuildInfo(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<BuildInfo>)>

  • 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<((axios?, basePath?) => AxiosPromise<BuildInfo>)>

    Summary

    Get information about the underlying Atlas mongod

    Throws