Categorygithub.com/umeshkumhar/backupdr-client
modulepackage
1.0.0
Repository: https://github.com/umeshkumhar/backupdr-client.git
Documentation: pkg.go.dev

# README

Go API client for swagger

This document defines the API for the Global Manager. All communication is done over HTTPS with UTF-8 encoding. JSON is the only supported format for both request and response payloads.

Please read <a href="https://cloud.google.com/backup-disaster-recovery/docs/api/RestAPIGeneralConcepts.pdf\">Management Console API General concept

To login, use the /session POST API below.

Then copy the resulting session_id from the output and click on the Authorize button on the top right. Paste the string "Actifio " followed by the session id into the form and click Authorize.

Login is not necessary for reading the rest of this API document. However, login will allow you to try the APIs out within this page.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: V11.0.4
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to /actifio

ClassMethodHTTP requestDescription
AccessRightApiGetRightGet /right/{right_name}Get details for a specific right. It requires System View right.
AccessRightApiListRightsGet /rightGet a list of rights in the system. Rights are predefined and cannot be changed. It requires System View right.
AccessRightApiOptionsForList1Options /rightDescribes the fields available for filtering and sorting
AccessRoleApiCountRolesHead /roleGet a count of total roles matching the filters. It requires System View right.
AccessRoleApiCreateRolePost /roleCreate a new role. It requires System Manage right.
AccessRoleApiDeleteRoleDelete /role/{role_id}Remove a specific role. It requires System Manage right.
AccessRoleApiGetRoleGet /role/{role_id}Get individual role details. It requires System View right.
AccessRoleApiListRolesGet /roleGet a list of users. It requires System View right.
AccessRoleApiOptionsForList2Options /roleDescribes the fields available for filtering and sorting
AccessRoleApiUpdateRolePut /role/{role_id}Update a specific role. It requires System Manage right.
ApplianceApiCountClustersHead /clusterGet a count of total appliances matching the filters. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceApiGetClusterGet /cluster/{cluster_id}Get individual appliance. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceApiListClustersGet /clusterGet a list of appliances. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceApiOptionsForListClusterOptions /clusterDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
ApplianceDelegationApiDelegateGetCallDownloadLogGet /appliancedelegation/{cluster_id}/config/download/logDownload logs from backup/recovery appliance. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceDelegationApiDownloadConnectorGet /appliancedelegation/{cluster_id}/connectorbinary/{connectorname}Download connectors from backup/recovery appliance. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceDelegationApiDownloadOssNoticeGet /appliancedelegation/{cluster_id}/config/download/ossnoticeDownload zip file containing licenses and notices for open-source components from backup/recovery appliance. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceDelegationApiUploadSoftwareUpgradeToAppliancePost /appliancedelegation/{cluster_id}/cluster/uploadupdateUpload software upgrade packages. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceUpdateApiCountApplianceUpdatesHead /applianceupdateGet a count of total applianceupdates matching the filters. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateApiDeleteScheduleDelete /applianceupdate/scheduleDeletes the schedule for update. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceUpdateApiDiscoverUpdatesPost /applianceupdate/discoverDiscover new updates for the managed appliances. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceUpdateApiGetApplianceUpdateGet /applianceupdate/{update_id}Get update details. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateApiGetNotificationsGet /applianceupdate/notificationFetch the notifications that needs to be displayed to the user. It requires backupdr.managementServers.access IAM permission
ApplianceUpdateApiGetReadMeForApplianceUpdateGet /applianceupdate/readmeGet readme with respect to the update id passed. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateApiInstallApplianceUpdateNowPost /applianceupdate/installnowInstall the updates now. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceUpdateApiListApplianceUpdatesGet /applianceupdateGet the list of actionable updates. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateApiOptionsForListApplianceUpdatesOptions /applianceupdateDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
ApplianceUpdateApiUpdateNotificationForApplianceUpdatePut /applianceupdate/notificationUpdate the acknowledge status of the notification to true
ApplianceUpdateApiUpdateSchedulePost /applianceupdate/scheduleCreates the schedule for update. It requires backupdr.managementServers.manageSystem IAM permission
ApplianceUpdateInstallationJobApiCountApplianceUpdatesInstallationJobsHead /applianceupdateinstallationjobGet the count of total appliance update installation jobs. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateInstallationJobApiGetApplianceUpdateInstallationJobGet /applianceupdateinstallationjob/{update_id}Get the appliance update job details. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateInstallationJobApiGetReadMeForApplianceUpdateInstallationJobGet /applianceupdateinstallationjob/readmeGet readme of the update id passed. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateInstallationJobApiGetUpdateLogsGet /applianceupdateinstallationjob/logGet logs of the update id passed. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateInstallationJobApiListApplianceUpdatesInstallationjobsGet /applianceupdateinstallationjobGet the list of update installation jobs. It requires backupdr.managementServers.viewSystem IAM permission
ApplianceUpdateInstallationJobApiOptionsForListApplianceUpdateInstallationJobsOptions /applianceupdateinstallationjobDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
ApplianceUpdateInstallationJobApiUpdateNotificationForApplianceUpdateInstallationJobPut /applianceupdateinstallationjob/notificationUpdate the acknowledge status of the notification to true
ApplicationApiBackupNowPost /application/{application_id}/backupRun a backup job. It requires backupdr.managementServers.manageBackups IAM permission
ApplicationApiCountApplicationsHead /applicationGet a count of total applications matching the filters. It requires backupdr.managementServers.access IAM permission
ApplicationApiCreateOptionForAppPost /application/{application_id}/settableoptionCreate a settable option for the particular application. It requires backupdr.managementServers.assignBackupPlans IAM permission
ApplicationApiCreateWorkflowPost /application/{application_id}/workflowCreate new workflow for the particular application. It requires backupdr.managementServers.manageWorkflows IAM permission
ApplicationApiDeleteApplicationDelete /application/{application_id}Delete application. It requires backupdr.managementServers.manageApplications IAM permission
ApplicationApiDeleteOptionForAppDelete /application/{application_id}/settableoption/{option_id}Delete the particular option from the particular application. It requires backupdr.managementServers.assignBackupPlans IAM permission
ApplicationApiDeleteWorkflowDelete /application/{application_id}/workflow/{workflow_id}Delete existing workflow. It requires backupdr.managementServers.manageWorkflows IAM permission
ApplicationApiExpireBackupsPost /application/{application_id}/expirebackupExpires backups of the particular application. It requires backupdr.managementServers.manageExpiration IAM permission
ApplicationApiGetAppClassGet /application/{application_id}/appclassGet the particular application's appclass metadata. It requires backupdr.managementServers.access IAM permission
ApplicationApiGetAppClassByAppclassNameGet /application/appclass/{appclass_name}Get appclass metadata for the particular appclass name. It requires backupdr.managementServers.access IAM permission
ApplicationApiGetAppClassesGet /application/appclassGet all available app classes from given cluster. It requires backupdr.managementServers.access IAM permission
ApplicationApiGetApplicationGet /application/{application_id}Get details on the particular application. It requires backupdr.managementServers.access IAM permission
ApplicationApiGetOptionForAppGet /application/{application_id}/settableoption/{option_id}Get the particular option of the particular application. It requires backupdr.managementServers.viewBackupPlans IAM permission
ApplicationApiGetWorkflowGet /application/{application_id}/workflow/{workflow_id}Get individual workflow. It requires backupdr.managementServers.viewWorkflows IAM permission
ApplicationApiListActiveImagesGet /application/{application_id}/activeimageGet active images for an application. It requires backupdr.managementServers.access IAM permission
ApplicationApiListApplicationTypesGet /application/typesGet list of application types that are currently in the system. It requires backupdr.managementServers.access IAM permission
ApplicationApiListApplicationsGet /applicationList applications. It requires backupdr.managementServers.access IAM permission
ApplicationApiListOptionForAppGet /application/{application_id}/settableoptionList all existing settable options of the application. It requires backupdr.managementServers.access IAM permission
ApplicationApiListWorkflowsPerAppGet /application/{application_id}/workflowGet list of workflows for the particular application. It requires backupdr.managementServers.viewWorkflows IAM permission
ApplicationApiOptionsForListApplicationOptions /applicationDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
ApplicationApiSettableOptionMetadataForAppOptions /application/{application_id}/settableoptionGet settable option metadata of the particular application. It requires backupdr.managementServers.access IAM permission
ApplicationApiSettableOptionMetadataForAppTypeOptions /application/settableoption/{apptype}Settable option metadata for the particular application type. It requires backupdr.managementServers.access IAM permission
ApplicationApiUpdateApplicationPut /application/{application_id}Update application data. It requires backupdr.managementServers.manageApplications and backupdr.managementServers.manageSensitiveData (for sensitive app) IAM permissions
ApplicationApiUpdateOptionForAppPut /application/{application_id}/settableoption/{option_id}Update the particular option of the particular application. It requires backupdr.managementServers.assignBackupPlans IAM permission
ApplicationApiUpdateWorkflowPut /application/{application_id}/workflow/{workflow_id}Update existing workflow. It requires backupdr.managementServers.manageWorkflows IAM permission
AuditLogApiCountAuditsHead /localauditGet a count of total audit records matching the filters. It requires backupdr.managementServers.viewSystem IAM permission
AuditLogApiGetAuditGet /localaudit/{audit_id}Get individual audit record details. It requires backupdr.managementServers.viewSystem IAM permission
AuditLogApiListAuditsGet /localauditGet a list of local audit records. It requires backupdr.managementServers.viewSystem IAM permission
AuditLogApiOptionsForListLocalAuditOptions /localauditDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.viewSystem IAM permission
BackupApiCloneBackupPost /backup/{backup_id}/cloneClone a specific backup. It requires backupdr.managementServers.manageClones and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiCountBackupsHead /backupGet a count of total backups matching the filters. It requires backupdr.managementServers.access IAM permission
BackupApiDeleteBackupDelete /backup/{backup_id}Delete a specific backup. It requires backupdr.managementServers.manageExpiration and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiExpireBackupPost /backup/{backup_id}/expireExpire a specific backup. It requires backupdr.managementServers.manageExpiration and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiFetchApplicationOptionsGet /backup/{backupid}/applicationOptionsGets the dynamic list of application options and corresponding default value (if any) for given backup image. It requires backupdr.managementServers.manageBackups and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiGetBackupGet /backup/{backup_id}Get individual backup details. It requires backupdr.managementServers.access and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiGetDiskMappingGet /backup/{backupid}/diskmappingGets disk mapping options for restore (source disks, target disks, RAC node list etc). It requires backupdr.managementServers.manageBackups and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiListBackupsGet /backupGet a list of backups. It requires backupdr.managementServers.access IAM permission
BackupApiLiveCloneBackupPost /backup/{backup_id}/livecloneCreate live-clone of a specific backup. It requires backupdr.managementServers.manageLiveClones and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiMigrateRestoreMountBackupPost /backup/{backupid}/restoremigrateSubmit restore-migrate for Oracle restore-mounted image. It requires backupdr.managementServers.manageMigrations and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiMountBackupPost /backup/{backup_id}/mountMount a specific backup. It require backupdr.managementServers.manageMounts IAM permission for mounting any backup, backupdr.managementServers.manageRestores IAM permission for restoring GCE backup, and backupdr.managementServers.accessSensitiveData IAM permission to access sensitive backup
BackupApiMountMigratePreflightPost /backup/{backupid}/mountmigratepreflightPerforms preflight check for Oracle restore-mount/restore-migrate operations. It requires backupdr.managementServers.manageMigrations and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiOptionsForListBackupOptions /backupDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
BackupApiPrepMountLiveCloneNewPost /backup/{backup_id}/prepmountPrep-mount a specific backup. It requires backupdr.managementServers.manageLiveClones and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiPrepUnmountBackupPost /backup/{backup_id}/prepunmountPrep-unmount a specific backup. It requires backupdr.managementServers.manageLiveClones and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiRefreshLiveClonePost /backup/{backup_id}/refreshRefresh a live-clone backup. It requires backupdr.managementServers.manageLiveClones and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiRestoreBackupPost /backup/{backup_id}/restoreRestore an application from a specific backup. It requires backupdr.managementServers.manageRestores and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiUnmountBackupPost /backup/{backup_id}/unmountUnmount a specific backup. It requires backupdr.managementServers.manageMounts and backupdr.managementServers.accessSensitiveData (for sensitive backup) IAM permissions
BackupApiUpdateBackupPut /backup/{backup_id}Update the specific backup. It requires backupdr.managementServers.manageExpiration IAM permission to update expiration, backupdr.managementServers.manageBackups IAM permission to update rest of the fields, backupdr.managementServers.accessSensitiveData IAM permission to update sensitive backup, and backupdr.managementServers.manageSensitiveData IAM permission to update sensitivity flag
ConfigurationApiGetVersionGet /config/versionGet version. No special IAM permission requirement as long as there is valid session id.
ConfigurationApiGetVersionDetailGet /config/versiondetailGet version details. No special IAM permission requirement as long as there is valid session id.
ConfigurationApiGetVmMetadataDetailsGet /config/mgmtconsoledetails
ConsistencyGroupApiCountConsistencyGroupsHead /consistencygroupGet a count of total consistency groups matching the filters. It requires backupdr.managementServers.access IAM permission
ConsistencyGroupApiCreateConsistencyGroupPost /consistencygroupCreate a new consistency group. It requires backupdr.managementServers.manageApplications IAM permission
ConsistencyGroupApiDeleteConsistencyGroupDelete /consistencygroup/{group_id}Remove a consistency group. It requires backupdr.managementServers.manageApplications IAM permission
ConsistencyGroupApiGetConsistencyGroupGet /consistencygroup/{group_id}Get individual consistency group details. It requires backupdr.managementServers.access IAM permission
ConsistencyGroupApiGetConsistencyGroupMemberGet /consistencygroup/{group_id}/memberGet consistency group's members. It requires backupdr.managementServers.access IAM permission
ConsistencyGroupApiListConsistencyGroupsGet /consistencygroupGet a list of consistency groups. It requires backupdr.managementServers.access IAM permission
ConsistencyGroupApiModifyConsistencyGroupMemberPost /consistencygroup/{group_id}/memberIncrementally add/delete consistency group members. It requires backupdr.managementServers.manageApplications IAM permission
ConsistencyGroupApiOptionsForListConsistencyGroupOptions /consistencygroupDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
ConsistencyGroupApiUpdateConsistencyGroupPut /consistencygroup/{group_id}Update a consistency group. It requires backupdr.managementServers.manageApplications IAM permission
DefaultApiAddCloudPoolPost /cloudcredential/{cloudcredential_id}/cloudpool
DefaultApiAddVmPost /cloudcredential/{cloudcredential_id}/discovervm/addvm
DefaultApiCountCloudCredentialsHead /cloudcredential
DefaultApiCountDynamicProtectionsHead /dynamicprotectionGet a count of total dynamic protection entries. It requires backupdr.managementServers.getDynamicProtection IAM permission
DefaultApiCreateCredentialPost /cloudcredential
DefaultApiCreateDynamicProtectionPost /dynamicprotectionCreate a new dynamic protection entry. It requires backupdr.managementServers.createDynamicProtection IAM permission
DefaultApiDeleteCloudPoolDelete /cloudcredential/{cloudcredential_id}/cloudpool
DefaultApiDeleteCredentialDelete /cloudcredential/{cloudcredential_id}
DefaultApiDeleteDynamicProtectionDelete /dynamicprotection/{dynamicprotection_id}Remove a dynamic protection entry. It requires backupdr.managementServers.deleteDynamicProtection IAM permission
DefaultApiDiscoverCloudVmPost /cloudcredential/{cloudcredential_id}/discovervm/vm
DefaultApiGetAllZonesGet /cloudcredential/{cloudcredential_id}/region/{region}/zone
DefaultApiGetCloudCredentialMetaInfoGet /cloudcredential/cloudtype/{type}/field
DefaultApiGetCloudTypesGet /cloudcredential/cloudtype
DefaultApiGetCloudVmMetaInfoGet /cloudcredential/cloudtype/{type}/vminfo
DefaultApiGetCredentialGet /cloudcredential/{cloudcredential_id}
DefaultApiGetDynamicProtectionGet /dynamicprotection/{dynamicprotection_id}Get individual dynamic protection entry details. It requires backupdr.managementServers.getDynamicProtection IAM permission
DefaultApiGetExternalGrammarGet /application.wadl/{path}
DefaultApiGetGCPProjectsGet /cloudcredential/{cloudcredential_id}/projects
DefaultApiGetMountVmParamsGet /cloudcredential/{cloudcredential_id}/region/{region}/mountinfo
DefaultApiGetRegionsGet /cloudcredential/cloudtype/{type}/region
DefaultApiGetWadlGet /application.wadl
DefaultApiListCredentialsGet /cloudcredential
DefaultApiListDiskTypesGet /cloudcredential/{cloudcredential_id}/disktypes
DefaultApiListDynamicProtectionsGet /dynamicprotectionGet a list of dynamic protection entries. It requires backupdr.managementServers.listDynamicProtection IAM
DefaultApiPromoteExistingCredentialPost /cloudcredential/{cloudcredential_id}/promote
DefaultApiRunDynamicProtectionJobPost /dynamicprotection/jobRun dynamic protection job. It requires backupdr.managementServers.assignBackupPlans IAM permission
DefaultApiSetDynamicProtectionJobConfigPut /dynamicprotection/jobconfigUpdate dynamic protection job config. It requires backupdr.managementServers.assignBackupPlans IAM permission
DefaultApiTestCredentialPost /cloudcredential/testconnection
DefaultApiUpdateCloudPoolPut /cloudcredential/{cloudcredential_id}/cloudpool
DefaultApiUpdateCredentialPut /cloudcredential/{cloudcredential_id}
DiskPoolApiCountDiskPoolsHead /diskpoolGet a count of total diskpools matching the filters. It requires backupdr.managementServers.viewStorage IAM permission
DiskPoolApiCreateDiskPoolPost /diskpoolCreate a new diskpool. It requires backupdr.managementServers.manageStorage IAM permission
DiskPoolApiDeleteDiskPoolDelete /diskpool/{diskpool_id}Remove the specific diskpool. It requires backupdr.managementServers.manageStorage IAM permission
DiskPoolApiGetDiskPoolGet /diskpool/{diskpool_id}Get individual diskpool details. It requires backupdr.managementServers.viewStorage IAM permission
DiskPoolApiGetDynamicJsonForPoolManageGet /diskpool/vault/listdynamicfields/{pool_type}List dynamic UI properties based on type of vault pool. It requires backupdr.managementServers.manageStorage IAM permission
DiskPoolApiGetVaultListGet /diskpool/vault/listtypeList types of vault pool. Requires Storage Manage right.
DiskPoolApiListDiskPoolsGet /diskpoolGet a list of diskpools. It requires backupdr.managementServers.viewStorage IAM permission
DiskPoolApiListGcpVaultPoolGet /diskpool/listgcpvaultpoolGet a list of GCP vault pools. This operation is network costly and UI needs to cache the result. It requires backupdr.managementServers.viewStorage IAM permission
DiskPoolApiOptionsForListDiskPoolOptions /diskpoolDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.viewStorage IAM permission
DiskPoolApiUpdateDiskPoolPut /diskpool/{diskpool_id}Update the specific diskpool. It requires backupdr.managementServers.manageStorage IAM permission
HostApiAddApplicationPost /host/{host_id}/addapplicationCreate a new application on the specific host. It requires backupdr.managementServers.manageApplications IAM permission
HostApiAppDiscoveryPost /host/{host_id}/appdiscoveryDiscover applications on the specific host. It requires backupdr.managementServers.manageApplications IAM permission
HostApiCountHostsHead /hostGet a count of total hosts matching the filters. It requires backupdr.managementServers.access IAM permission
HostApiCreateHostPost /hostCreate a new host. It requires backupdr.managementServers.manageHosts IAM permission
HostApiDeleteHostDelete /host/{host_id}Delete a host completely or remove the host from selective appliances. It requires backupdr.managementServers.manageHosts IAM permission
HostApiEnableConnectorUpgradePost /host/enableconnectorupgrade
HostApiGetHostGet /host/{host_id}Get individual host details. It requires backupdr.managementServers.access IAM permission
HostApiListHostsGet /hostGet a list of host. It requires backupdr.managementServers.access IAM permission
HostApiOptionsForListHostOptions /hostDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
HostApiRevokeCertificatePut /host/revokeCertificateRevokes existing certificates of passed in host and blocks them from creating any new certificates. It requires backupdr.managementServers.manageHosts IAM permission
HostApiTestConnectorConnectionPost /host/{hostid}/testconnectorconnection
HostApiUpdateHostPut /host/{host_id}Update a host. It requires backupdr.managementServers.manageHosts IAM permission
HostApiVmAddNewPost /host/{host_id}/host/{cluster_name}/addvmsAdd discovered VMs to appliances asynchronously. It requires backupdr.managementServers.manageHosts IAM permission
HostApiVmDiscoveryWithoutClusterGet /host/{host_id}/discovervmDiscover VMS on the specific host. It requires backupdr.managementServers.manageHosts IAM permission
JobApiCountCombinedJobHead /jobstatusGet a count of total jobs (including running jobs and finished jobs) matching the filters. It requires backupdr.managementServers.access IAM permission
JobApiListCombinedJobsGet /jobstatusGet a list of jobs (including running jobs and finished jobs). It requires backupdr.managementServers.access IAM permission
JobApiOptionsForListCombinedJobOptions /jobstatusDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiCountLogicalGroupsHead /logicalgroupGet a count of total logical groups matching the filters. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiCreateLogicalGroupPost /logicalgroupCreate a new logical group. It requires backupdr.managementServers.manageApplications IAM permission
LogicalGroupApiCreateLogicalGroupSlaPost /logicalgroup/{group_id}/slaProtect a logical group. It creates individual SLAs for all members. It requires backupdr.managementServers.assignBackupPlans IAM permission
LogicalGroupApiDeleteLogicalGroupDelete /logicalgroup/{group_id}Remove a logical group. It requires backupdr.managementServers.manageApplications IAM permission
LogicalGroupApiDeleteLogicalGroupSlaDelete /logicalgroup/{group_id}/slaUnprotect a logical group. It removes SLAs for all members. It requires backupdr.managementServers.assignBackupPlans IAM permission
LogicalGroupApiGetLogicalGroupGet /logicalgroup/{group_id}Get individual logical group details. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiListLogicalGroupGet /logicalgroupGet a list of logical groups. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiListLogicalGroupMembersGet /logicalgroup/{group_id}/memberGet logical group's members. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiModifyLogicalGroupMembersPost /logicalgroup/{group_id}/memberIncrementally add/delete logical group members. It requires backupdr.managementServers.manageApplications IAM permission
LogicalGroupApiOptionsForListLogicalGroupOptions /logicalgroupDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
LogicalGroupApiUpdateLogicalGroupPut /logicalgroup/{group_id}Update a logical group. It requires backupdr.managementServers.manageApplications IAM permission
LogicalGroupApiUpdateLogicalGroupSlaPut /logicalgroup/{group_id}/slaUpdate the current SLAs for a logical group. It updates individual SLAs for all members. It requires backupdr.managementServers.assignBackupPlans IAM permission
ManageACLApiGetDbDumpUploadUrlsPost /manageacl/migration/getdbdumpuploadurls
ManageACLApiGetRMMigrationStatusGet /manageacl/migration/rmmigrationstatus
ManageACLApiIsInMigrationModeGet /manageacl/migration/isinmigrationmode
ManageACLApiPromoteUserPut /manageacl/promoteUserTo promote the IAP Manage Acl users to Administrator role
ManageACLApiStoreSecretKeysPost /manageacl/migration/savesecret
OrganizationApiAddResourcesToOrgPost /org/{org_id}/assignment/addAdd resources to a specific organization. It requires System Manage right.
OrganizationApiCountOrgsHead /orgGet a count of total organizations matching the filters. It requires System View right.
OrganizationApiCreateOrgPost /orgCreate a new organization. It requires System Manage right.
OrganizationApiDeleteOrgDelete /org/{org_id}Remove a specific organization. It requires System Manage right.
OrganizationApiGetOrgGet /org/{org_id}Get individual organization details.
OrganizationApiListOrgsGet /orgGet a list of organizations.
OrganizationApiOptionsForListOptions /orgDescribes the fields available for filtering and sorting
OrganizationApiRemoveResourcesFromOrgPost /org/{org_id}/assignment/removeRemove resources from a specific organization. It requires System Manage right.
OrganizationApiUpdateOrgPut /org/{org_id}Update a specific organization. It requires System Manage right.
SLAApiCountSlasHead /slaGet a count of total SLAs matching the filters. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiCreateOptionForSlaPost /sla/{sla_id}/settableoptionCreate an overridden option on the specific SLA. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAApiCreateSlaPost /slaCreate a new SLA. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAApiCreateSlaPreflightPost /sla/preflightPreflight on creating a new SLA. It requires SLA Assign right.
SLAApiDeleteOptionForSlaDelete /sla/{sla_id}/settableoption/{option_id}Delete a specific overridden option on the specific SLA. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAApiDeleteSlaDelete /sla/{sla_id}Remove the specific SLA. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAApiGetOptionForSlaGet /sla/{sla_id}/settableoption/{option_id}Get the details of a specific overridden option on the specific SLA. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiGetSlaGet /sla/{sla_id}Get individual SLA details. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiListOptionForSlaGet /sla/{sla_id}/settableoptionList all overridden options already set on the specific SLA. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiListSlasGet /slaGet a list of SLAs. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiSettableOptionMetadataForSlaOptions /sla/{sla_id}/settableoptionList all overridable option metadata for the specific SLA. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAApiUpdateOptionForSlaPut /sla/{sla_id}/settableoption/{option_id}Update a specific overridden option on the specific SLA. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAApiUpdateSlaPut /sla/{sla_id}Update the specific slp. It requires backupdr.managementServers.assignBackupPlans IAM permission
SLAProfileApiCountSlpsHead /slpGet a count of total slps matching the filters. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAProfileApiCreateSlpPost /slpCreate a new slp. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLAProfileApiDeleteSlpDelete /slp/{slp_id}Remove the specific slp. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLAProfileApiGetGCPProjectsByProfileGet /slp/{slp_id}/projects
SLAProfileApiGetSlpGet /slp/{slp_id}Get individual slp details. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAProfileApiListSlpsGet /slpGet a list of slps. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLAProfileApiUpdateSlpPut /slp/{slp_id}Update the specific slp. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiCloneTemplatesPost /slt/{slt_id}/cloneClone a specific slt. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiCountSltsHead /sltGet a count of total slts matching the filters. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiCreateOptionForPolicyPost /slt/{slt_id}/policy/{policy_id}/settableoptionCreate a new settable option for the specific policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiCreatePolicyPost /slt/{slt_id}/policyCreate a new policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiCreateSltPost /sltCreate a new slt. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiDeleteOptionForPolicyDelete /slt/{slt_id}/policy/{policy_id}/settableoption/{option_id}Remove a settable option for the specific policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiDeletePolicyDelete /slt/{slt_id}/policy/{policy_id}Remove a policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiDeleteSltDelete /slt/{slt_id}Remove a slt. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiGetOptionForPolicyGet /slt/{slt_id}/policy/{policy_id}/settableoption/{option_id}Get a specific settable option of the specific policy. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiGetPolicyGet /slt/{slt_id}/policy/{policy_id}Get individual policy. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiGetSltGet /slt/{slt_id}Get individual slt details. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiListOptionForPolicyGet /slt/{slt_id}/policy/{policy_id}/settableoptionList all existing settable options of the specific policy. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiListPoliciesGet /slt/{slt_id}/policyGet policy list from the specific slt. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiListSltsGet /sltGet a list of slts. It requires backupdr.managementServers.viewBackupPlans IAM permission
SLATemplateApiOptionsForListSltOptions /sltDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.access IAM permission
SLATemplateApiSettableOptionMetadataForPolicyOptions /slt/{slt_id}/policy/{policy_id}/settableoptionGet settable option metadata for the specific policy. It requires backupdr.managementServers.access IAM permission
SLATemplateApiSettableOptionMetadataForPolicyTypeOptions /slt/settableoption/{policytype}Get settable option metadata for the specific policy type. It requires backupdr.managementServers.access IAM permission
SLATemplateApiUpdateOptionForPolicyPut /slt/{slt_id}/policy/{policy_id}/settableoption/{option_id}Update a settable option for the specific policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiUpdatePolicyPut /slt/{slt_id}/policy/{policy_id}Update a policy. It requires backupdr.managementServers.manageBackupPlans IAM permission
SLATemplateApiUpdateSltPut /slt/{slt_id}Update a slt. It requires backupdr.managementServers.manageBackupPlans IAM permission
StorageArrayApiCountArraysHead /arrayGet a count of total storage arrays matching the filters. It requires backupdr.managementServers.viewStorage IAM permission
StorageArrayApiCreateArrayPost /arrayCreate a storage array. It requires backupdr.managementServers.manageStorage IAM permission
StorageArrayApiCredentialTestPost /array/pretestCredential test before creating a storage array. It requires backupdr.managementServers.manageStorage IAM permission
StorageArrayApiDeleteArrayDelete /array/{array_id}Remove the specific storage array from all appliances. It requires backupdr.managementServers.manageStorage IAM permission
StorageArrayApiGetArrayGet /array/{array_id}Get individual storage array details. It requires backupdr.managementServers.viewStorage IAM permission
StorageArrayApiGetArrayTypesGet /array/typeGet all supported storage array types from appliances. It requires backupdr.managementServers.viewStorage IAM permission
StorageArrayApiListArraysGet /arrayGet a list of storage arrays. It requires backupdr.managementServers.viewStorage IAM permission
StorageArrayApiOptionsForListArrayOptions /arrayDescribes the fields available for filtering and sorting. It requires backupdr.managementServers.viewStorage IAM permission
StorageArrayApiTestArrayPost /array/{array_id}Connectivity test on the specific storage array. It requires backupdr.managementServers.manageStorage IAM permission
StorageArrayApiUpdateArrayPut /array/{array_id}Update a specific storage array. It requires backupdr.managementServers.manageStorage IAM permission
UserApiCountUsersHead /userGet a count of total users matching the filters. It requires System View right.
UserApiCreateUserPost /userCreate a new user. It requires System Manage right.
UserApiDeleteUserDelete /user/{user_id}Remove a specific user. It requires System Manage right.
UserApiGetUserGet /user/{user_id}Get individual user details. It requires System View right.
UserApiListRoles1Get /userGet a list of users. It requires System View right.
UserApiOptionsForList3Options /userDescribes the fields available for filtering and sorting
UserApiUpdateUserPut /user/{user_id}Update a specific user. It requires System Manage right.
UserSessionApiGetPermissionsGet /session/permissionsGet IAM permissions for the user
UserSessionApiGetSessionInfoGet /session/currentGet session information, including user preferences. It requires backupdr.managementServers.access IAM permission
UserSessionApiLoginPost /sessionRegister an user session
UserSessionApiLogoutDelete /session/currentDeregister the current user session
UserSessionApiPutUserprefPut /session/currentUpdate user preferences

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the Backup and DR Service: Management Console API Spec API vV11.0.4 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Application Rest Object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Configured authentication method.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Backup Rest Object.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Appliance where the application resides.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Base class for REST objects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Host where the application resides.
This object represents the results of IAM permission checks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The logical group that the application belongs to, if it applies.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This object represent a valid login session.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Available SLP (profiles) that this application can potentially use for protection.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author