Function AppsApiAxiosParamCreator

Returns {
    adminCreateApplication: ((groupId, body, defaults?, product?, options?) => Promise<RequestArgs>);
    adminDeleteApplication: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminExportApplication: ((groupId, appId, deployment?, sourceControl?, template?, version?, options?) => Promise<RequestArgs>);
    adminGetApplication: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminListApplications: ((groupId, product?, options?) => Promise<RequestArgs>);
}

• adminCreateApplication: ((groupId, body, defaults?, product?, options?) => Promise<RequestArgs>)

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

    • Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • body: any

        The application to create.

      • Optional defaults: any

        Whether or not to create a default application.

      • Optional product: AdminCreateApplicationProductEnum

        The App&#39;s product type. Apps use the `standard` product type by default. For most apps, you do not need to specify a `product` at all, or should specify `standard`. The `atlas` and `data-api` product types represent special, apps for Atlas Triggers and Atlas Data API that you can access through the Atlas UI.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a new app

      Throws

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

  • • (groupId, appId, 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.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete an app

      Throws

• adminExportApplication: ((groupId, appId, deployment?, sourceControl?, template?, version?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, deployment?, sourceControl?, template?, version?, options?): Promise<RequestArgs>

    • Export an application as a zip file.

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

        The `_id` of a specific deployment to export. If not specified, export the latest deployment.

      • Optional sourceControl: any

        If `true`, the exported directory is suitable for automatic deployment from GitHub or other source control. Cannot be used with the `template` query parameter.

      • Optional template: any

        If `true`, the exported directory does not include any identifiers or other data that would tie the app to a specific deployment instance. Cannot be used with the `source_control` query parameter.

      • Optional version: any

        The configuration file schema version to export. This value corresponds to `config_version` in `realm_config.json`.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Export an app as a zip file

      Throws

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

  • • (groupId, appId, 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.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get an app

      Throws

• adminListApplications: ((groupId, product?, options?) => Promise<RequestArgs>)

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

    • List all App Services Apps within an Atlas project/group.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • Optional product: AdminListApplicationsProductEnum

        One or more specific App Services product types. If specified, this endpoint only returns Apps of the specified product type(s). Most apps use the `standard` product type, which this endpoint returns by default. The `atlas` and `data-api` product types represent special apps for Atlas Triggers and Atlas Data API that you can access through the Atlas UI. You can specify multiple product types as a comma-separated list: ``` /groups/{groupId}/apps?product=atlas,data-api ```

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List all App Services Apps in an Atlas project/group

      Throws