Class BackupApi

BackupApi - object-oriented interface

Hierarchy

BaseAPI
- BackupApi

Index

Constructors

Properties

axios basePath configuration

Methods

createBackup getBackup listBackups startRestoreBackup

Constructors

constructor

new BackupApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): BackupApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns BackupApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:38

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

createBackup

createBackup(
requestParameters?: BackupApiCreateBackupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BackupManifestDto, any, {}>>
Parameters
- requestParameters: BackupApiCreateBackupRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BackupManifestDto, any, {}>>

Throws
- Defined in generated-client/api/backup-api.ts:335

getBackup

getBackup(
requestParameters: BackupApiGetBackupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BackupManifestDto, any, {}>>
Parameters
- requestParameters: BackupApiGetBackupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BackupManifestDto, any, {}>>

Throws
- Defined in generated-client/api/backup-api.ts:346

listBackups

listBackups(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BackupManifestDto[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BackupManifestDto[], any, {}>>

Throws
- Defined in generated-client/api/backup-api.ts:356

startRestoreBackup

startRestoreBackup(
requestParameters: BackupApiStartRestoreBackupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: BackupApiStartRestoreBackupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/backup-api.ts:367