Function HostingApiFactory

Returns {
    adminEnableDisableHosting(groupId, appId, adminEnableDisableHostingRequest?, options?) => AxiosPromise<void>;
    adminGetAllHostedAssets(groupId, appId, options?) => AxiosPromise<any>;
    adminGetHostedAsset(path, prefix?, options?) => AxiosPromise<HostedAssetMetadata>;
    adminGetHostingConfig(groupId, appId, options?) => AxiosPromise<HostingConfiguration>;
    adminMoveCopyHostedAsset(groupId, appId, adminMoveCopyHostedAssetRequest, options?) => AxiosPromise<void>;
    adminUpdateHostedAsset(path, adminUpdateHostedAssetRequest, options?) => AxiosPromise<void>;
    adminUploadHostedAsset(path, adminUploadHostedAssetRequest, options?) => AxiosPromise<void>;
}

• adminEnableDisableHosting:function

  • adminEnableDisableHosting(groupId, appId, adminEnableDisableHostingRequest?, options?): AxiosPromise<void>

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

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Enable/Disable Hosting

    Throws

• adminGetAllHostedAssets:function

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

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List all hosted assets

    Throws

• adminGetHostedAsset:function

  • adminGetHostedAsset(path, prefix?, options?): AxiosPromise<HostedAssetMetadata>

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

      Override http request option.

    Returns AxiosPromise<HostedAssetMetadata>

    Summary

    Retrieve metadata for a specific hosted asset

    Throws

• adminGetHostingConfig:function

  • adminGetHostingConfig(groupId, appId, options?): AxiosPromise<HostingConfiguration>

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

      Override http request option.

    Returns AxiosPromise<HostingConfiguration>

    Summary

    Get Hosting Configuration

    Throws

• adminMoveCopyHostedAsset:function

  • adminMoveCopyHostedAsset(groupId, appId, adminMoveCopyHostedAssetRequest, options?): AxiosPromise<void>

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

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Move or copy a hosted asset

    Throws

• adminUpdateHostedAsset:function

  • adminUpdateHostedAsset(path, adminUpdateHostedAssetRequest, options?): AxiosPromise<void>

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

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Update the metadata attributes of a hosted asset

    Throws

• adminUploadHostedAsset:function

  • adminUploadHostedAsset(path, adminUploadHostedAssetRequest, options?): AxiosPromise<void>

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

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Upload or replace a hosted asset

    Throws