Function HostingApiAxiosParamCreator

Returns {
    adminEnableDisableHosting: ((groupId, appId, adminEnableDisableHostingRequest?, options?) => Promise<RequestArgs>);
    adminGetAllHostedAssets: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminGetHostedAsset: ((path, prefix?, options?) => Promise<RequestArgs>);
    adminGetHostingConfig: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminMoveCopyHostedAsset: ((groupId, appId, adminMoveCopyHostedAssetRequest, options?) => Promise<RequestArgs>);
    adminUpdateHostedAsset: ((path, adminUpdateHostedAssetRequest, options?) => Promise<RequestArgs>);
    adminUploadHostedAsset: ((path, adminUploadHostedAssetRequest, options?) => Promise<RequestArgs>);
}

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

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

    • Enable or disable App Services Hosting for your app. Changes to hosting can take up to 15 minutes to take effect. This endpoint does not notify you when the changes have taken effect, only that the change operation was successfully received by the server. You can see if the hosting enablement/disablement is complete by calling the Get Hosting Configuration 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.

      • Optional adminEnableDisableHostingRequest: AdminEnableDisableHostingRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Enable/Disable Hosting

      Throws

• adminGetAllHostedAssets: ((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

      List all hosted assets

      Throws

• adminGetHostedAsset: ((path, prefix?, options?) => Promise<RequestArgs>)

  • • (path, prefix?, options?): Promise<RequestArgs>

    • Parameters

      • path: any

        The resource path of a hosted asset.

      • Optional prefix: any

        Return only those assets where the resource path begins with the specified prefix.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Retrieve metadata for a specific hosted asset

      Throws

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

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

    • Returns the current hosting configuration. Hosting is active if the response includes status: \"setup_ok\".

      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 Hosting Configuration

      Throws

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

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

    • Move or copy a hosted asset to a new resource path.

      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.

      • adminMoveCopyHostedAssetRequest: AdminMoveCopyHostedAssetRequest

        The hosted asset file and its metadata. (Must use `Content-Type: multipart/mixed`)

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Move or copy a hosted asset

      Throws

• adminUpdateHostedAsset: ((path, adminUpdateHostedAssetRequest, options?) => Promise<RequestArgs>)

  • • (path, adminUpdateHostedAssetRequest, options?): Promise<RequestArgs>

    • Update the metadata attributes of a hosted asset at a specific resource path.

      Parameters

      • path: any

        The resource path of a hosted asset.

      • adminUpdateHostedAssetRequest: AdminUpdateHostedAssetRequest

        The new metadata attributes for the hosted asset. These attributes replace all existing attributes for the file.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update the metadata attributes of a hosted asset

      Throws

• adminUploadHostedAsset: ((path, adminUploadHostedAssetRequest, options?) => Promise<RequestArgs>)

  • • (path, adminUploadHostedAssetRequest, options?): Promise<RequestArgs>

    • Upload or replace a hosted asset at a specific resource path.

      Parameters

      • path: any

        The resource path of a hosted asset.

      • adminUploadHostedAssetRequest: AdminUploadHostedAssetRequest

        The hosted asset file and its metadata. (Must use `Content-Type: multipart/mixed`)

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Upload or replace a hosted asset

      Throws