Class HostingApi

HostingApi - object-oriented interface

Export

Hierarchy

BaseAPI
- HostingApi

Implements

HostingApiInterface

Index

Constructors

constructor

new HostingApi(configuration?, basePath?, axios?): HostingApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns HostingApi
Inherited from BaseAPI.constructor
- Defined in src/base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

adminEnableDisableHosting

adminEnableDisableHosting(groupId, appId, adminEnableDisableHostingRequest?, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>

Summary
Enable/Disable Hosting

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminEnableDisableHosting
- Defined in src/api.ts:12800

adminGetAllHostedAssets

adminGetAllHostedAssets(groupId, appId, options?): Promise<AxiosResponse<any, 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: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<any, any>>

Summary
List all hosted assets

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminGetAllHostedAssets
- Defined in src/api.ts:12813

adminGetHostedAsset

adminGetHostedAsset(path, prefix?, options?): Promise<AxiosResponse<HostedAssetMetadata, any>>
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<AxiosResponse<HostedAssetMetadata, any>>

Summary
Retrieve metadata for a specific hosted asset

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminGetHostedAsset
- Defined in src/api.ts:12826

adminGetHostingConfig

adminGetHostingConfig(groupId, appId, options?): Promise<AxiosResponse<HostingConfiguration, any>>
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<AxiosResponse<HostingConfiguration, any>>

Summary
Get Hosting Configuration

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminGetHostingConfig
- Defined in src/api.ts:12839

adminMoveCopyHostedAsset

adminMoveCopyHostedAsset(groupId, appId, adminMoveCopyHostedAssetRequest, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>

Summary
Move or copy a hosted asset

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminMoveCopyHostedAsset
- Defined in src/api.ts:12853

adminUpdateHostedAsset

adminUpdateHostedAsset(path, adminUpdateHostedAssetRequest, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>

Summary
Update the metadata attributes of a hosted asset

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminUpdateHostedAsset
- Defined in src/api.ts:12866

adminUploadHostedAsset

adminUploadHostedAsset(path, adminUploadHostedAssetRequest, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>

Summary
Upload or replace a hosted asset

Throws

Memberof
HostingApi
Implementation of HostingApiInterface.adminUploadHostedAsset
- Defined in src/api.ts:12879

Class HostingApi

Export

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns HostingApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

adminEnableDisableHosting

Parameters

groupId: any

appId: any

Optional adminEnableDisableHostingRequest: AdminEnableDisableHostingRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminGetAllHostedAssets

Parameters

groupId: any

appId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<any, any>>

Summary

Throws

Memberof

adminGetHostedAsset

Parameters

path: any

Optional prefix: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<HostedAssetMetadata, any>>

Summary

Throws

Memberof

adminGetHostingConfig

Parameters

groupId: any

appId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<HostingConfiguration, any>>

Summary

Throws

Memberof

adminMoveCopyHostedAsset

Parameters

groupId: any

appId: any

adminMoveCopyHostedAssetRequest: AdminMoveCopyHostedAssetRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminUpdateHostedAsset

Parameters

path: any

adminUpdateHostedAssetRequest: AdminUpdateHostedAssetRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminUploadHostedAsset

Parameters

path: any

adminUploadHostedAssetRequest: AdminUploadHostedAssetRequest

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` adminEnableDisableHostingRequest: AdminEnableDisableHostingRequest

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` prefix: any

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>