flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

BackupEngines_List

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

OnInit
./lib/actions/BackupEngines_List.js
OnStartup
-
OnClose
-

Attributes

-

BackupEngines_Get

Returns backup management server registered to Recovery Services Vault.

OnInit
./lib/actions/BackupEngines_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionContainerRefreshOperationResults_Get

Provides the result of the refresh operation triggered by the BeginRefresh operation.

OnInit
./lib/actions/ProtectionContainerRefreshOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionContainers_Get

Gets details of the specific container registered to your Recovery Services Vault.

OnInit
./lib/actions/ProtectionContainers_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionContainerOperationResults_Get

Fetches the result of any operation on the container.

OnInit
./lib/actions/ProtectionContainerOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectedItems_Delete

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

OnInit
./lib/actions/ProtectedItems_Delete.js
OnStartup
-
OnClose
-

Attributes

-

ProtectedItems_Get

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

OnInit
./lib/actions/ProtectedItems_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectedItems_CreateOrUpdate

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

OnInit
./lib/actions/ProtectedItems_CreateOrUpdate.js
OnStartup
-
OnClose
-

Attributes

-

Backups_Trigger

Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.

OnInit
./lib/actions/Backups_Trigger.js
OnStartup
-
OnClose
-

Attributes

-

ProtectedItemOperationResults_Get

Fetches the result of any operation on the backup item.

OnInit
./lib/actions/ProtectedItemOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectedItemOperationStatuses_Get

Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.

OnInit
./lib/actions/ProtectedItemOperationStatuses_Get.js
OnStartup
-
OnClose
-

Attributes

-

RecoveryPoints_List

Lists the backup copies for the backed up item.

OnInit
./lib/actions/RecoveryPoints_List.js
OnStartup
-
OnClose
-

Attributes

-

RecoveryPoints_Get

Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.

OnInit
./lib/actions/RecoveryPoints_Get.js
OnStartup
-
OnClose
-

Attributes

-

ItemLevelRecoveryConnections_Provision

Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.

OnInit
./lib/actions/ItemLevelRecoveryConnections_Provision.js
OnStartup
-
OnClose
-

Attributes

-

Restores_Trigger

Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

OnInit
./lib/actions/Restores_Trigger.js
OnStartup
-
OnClose
-

Attributes

-

ItemLevelRecoveryConnections_Revoke

Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.

OnInit
./lib/actions/ItemLevelRecoveryConnections_Revoke.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionContainers_Refresh

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.

OnInit
./lib/actions/ProtectionContainers_Refresh.js
OnStartup
-
OnClose
-

Attributes

-

ExportJobsOperationResults_Get

Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.

OnInit
./lib/actions/ExportJobsOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

JobCancellations_Trigger

Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

OnInit
./lib/actions/JobCancellations_Trigger.js
OnStartup
-
OnClose
-

Attributes

-

JobOperationResults_Get

Fetches the result of any operation. the operation.

OnInit
./lib/actions/JobOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

Jobs_Export

Triggers export of jobs specified by filters and returns an OperationID to track.

OnInit
./lib/actions/Jobs_Export.js
OnStartup
-
OnClose
-

Attributes

-

BackupOperationResults_Get

Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.

OnInit
./lib/actions/BackupOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupOperationStatuses_Get

Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.

OnInit
./lib/actions/BackupOperationStatuses_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupPolicies_List

Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.

OnInit
./lib/actions/BackupPolicies_List.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionPolicies_Delete

Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.

OnInit
./lib/actions/ProtectionPolicies_Delete.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionPolicies_Get

Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.

OnInit
./lib/actions/ProtectionPolicies_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionPolicies_CreateOrUpdate

Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.

OnInit
./lib/actions/ProtectionPolicies_CreateOrUpdate.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionPolicyOperationResults_Get

Provides the result of an operation.

OnInit
./lib/actions/ProtectionPolicyOperationResults_Get.js
OnStartup
-
OnClose
-

Attributes

-

ProtectionPolicyOperationStatuses_Get

Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.

OnInit
./lib/actions/ProtectionPolicyOperationStatuses_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupProtectableItems_List

Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.

OnInit
./lib/actions/BackupProtectableItems_List.js
OnStartup
-
OnClose
-

Attributes

-

BackupProtectedItems_List

Provides a pageable list of all items that are backed up within a vault.

OnInit
./lib/actions/BackupProtectedItems_List.js
OnStartup
-
OnClose
-

Attributes

-

BackupProtectionContainers_List

Lists the containers registered to Recovery Services Vault.

OnInit
./lib/actions/BackupProtectionContainers_List.js
OnStartup
-
OnClose
-

Attributes

-

SecurityPINs_Get

Get the security PIN.

OnInit
./lib/actions/SecurityPINs_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupUsageSummaries_List

Fetches the backup management usage summaries of the vault.

OnInit
./lib/actions/BackupUsageSummaries_List.js
OnStartup
-
OnClose
-

Attributes

-

BackupResourceVaultConfigs_Get

Fetches resource vault config.

OnInit
./lib/actions/BackupResourceVaultConfigs_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupResourceVaultConfigs_Update

Updates vault security config.

OnInit
./lib/actions/BackupResourceVaultConfigs_Update.js
OnStartup
-
OnClose
-

Attributes

-

BackupResourceStorageConfigs_Get

Fetches resource storage config.

OnInit
./lib/actions/BackupResourceStorageConfigs_Get.js
OnStartup
-
OnClose
-

Attributes

-

BackupResourceStorageConfigs_Update

Updates vault storage model type.

OnInit
./lib/actions/BackupResourceStorageConfigs_Update.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-