Skip to main content

Get protection group Properties​

Retrieves the properties of the protection Group configuration.

Responses

Success

Schema
  • filterQueryCount int32

    total count

  • protectionGroupProperties object
  • id int32

    This is protection group id

  • name string

    This is protection group name

  • agent object

    Details of protection group agent

  • id int32
  • name string
  • backupset object

    Details of protection group backupset

  • id int32
  • name string
  • instance object

    Details of protection group instance

  • id int32
  • name string
  • serverGroup object

    Details of protection group server group

  • id int32
  • name string
  • company object
  • id int32

    Id of company

  • name string

    Name of company

  • multiCommcellId int32

    Multi Commcell Id of company

  • lastBackup object
  • jobId int32

    Returns the job id of the last backup job performed.

  • status string

    Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

    Status of the last backup job performed.

  • time int64

    Shows the time when the last back up job was carried out. The time is provided in unix time format.

  • failureReason string

    Gives the reason for the last backup job failing, if the last backup job fails.

  • creationTime int32

    This gives the creation time of the protection group.

  • status int32

    This is protection group status

  • cloudConnection object

    Details of clould connection

  • id int32
  • name string
  • deleteActions object

    When a protection group is deleted, specify what actions should be taken regarding the entities that were created by the protection group

  • deconfigureResources boolean

    Do you want to deconfigure resources created by protection group

  • decoupleResources boolean

    Do you want to disassociate accounts from Protection Group and backup keep running

  • content object[]
  • matchRule MatchRule

    Possible values: [ALL, ANY]

    Enum which specifies the whether to match all rules or any of the rules

  • rules object[]
  • type string

    Possible values: [NONE, TAG, TAG_CATEGORY, REGION, ALL, RESOURCE]

    Type of rule

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • name string

    Name of the rule (region name, tag name, or resource name)

  • value string

    Value identifier (ID for regions/tags, or resource value or guid)

  • displayName string

    Human-readable display name

  • description string

    Description of the rule

  • resourceType RuleResourceTypes

    Possible values: [NONE, AZURE_VIRTUAL_MACHINE, AZURE_VM_SCALE_SET, AZURE_KUBERNETES_SERVICE, AZURE_STORAGE_ACCOUNT, AZURE_BLOB_STORAGE, AZURE_FILE_STORAGE, AZURE_QUEUE_STORAGE, AZURE_TABLE_STORAGE, AZURE_COSMOS_DB_ACCOUNT, AZURE_COSMOS_DB_SQL_ACCOUNT, AZURE_COSMOS_DB_MONGODB_RU_ACCOUNT, AZURE_COSMOS_DB_CASSANDRA_RU_ACCOUNT, AZURE_COSMOS_DB_GREMLIN_ACCOUNT, AZURE_COSMOS_DB_TABLE_ACCOUNT, AZURE_SQL_DATABASE, AZURE_POSTGRESQL_SERVER, AZURE_MY_SQL_SERVER, AZURE_MY_SQL_SERVER_FLEXIBLE, AZURE_POSTGRESQL_SERVER_FLEXIBLE, AMAZON_EC2_VIRTUAL_MACHINE, AMAZON_S3_STORAGE, AMAZON_RDS, AMAZON_DYNAMO_DB, AMAZON_DOCUMENT_DB, M365_ONE_DRIVE_APP, M365_EXCHANGE_APP, M365_TEAMS_APP, M365_SHAREPOINT_APP, AMAZON_ELASTIC_KUBERNETES_SERVICE, AMAZON_FSX_FILE_SYSTEM, GOOGLE_CLOUD_VIRTUAL_MACHINE, GOOGLE_CLOUD_SQL_DATABASE, GOOGLE_CLOUD_BIG_QUERY_DATABASE, GOOGLE_CLOUD_ALLOY_DB_DATABASE, GOOGLE_CLOUD_FILE_STORAGE, GOOGLE_CLOUD_SPANNER, AZURE_DATA_LAKE_STORAGE, AMAZON_RDS_MARIA_DB, AMAZON_RDS_MY_SQL_DB, AMAZON_RDS_SQL_SERVER_DB, AMAZON_RDS_POSTGRESQL_DB, AMAZON_AURORA_MY_SQL_DB, AMAZON_AURORA_POSTGRESQL_DB, AMAZON_REDSHIFT, AMAZON_RDS_ORACLE_DB, AMAZON_RDS_DB2_DB, AMAZON_ELASTIC_FILE_SYSTEM]

  • description string
  • filterContent object[]
  • matchRule MatchRule

    Possible values: [ALL, ANY]

    Enum which specifies the whether to match all rules or any of the rules

  • rules object[]
  • type string

    Possible values: [NONE, TAG, TAG_CATEGORY, REGION, ALL, RESOURCE]

    Type of rule

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • name string

    Name of the rule (region name, tag name, or resource name)

  • value string

    Value identifier (ID for regions/tags, or resource value or guid)

  • displayName string

    Human-readable display name

  • description string

    Description of the rule

  • resourceType RuleResourceTypes

    Possible values: [NONE, AZURE_VIRTUAL_MACHINE, AZURE_VM_SCALE_SET, AZURE_KUBERNETES_SERVICE, AZURE_STORAGE_ACCOUNT, AZURE_BLOB_STORAGE, AZURE_FILE_STORAGE, AZURE_QUEUE_STORAGE, AZURE_TABLE_STORAGE, AZURE_COSMOS_DB_ACCOUNT, AZURE_COSMOS_DB_SQL_ACCOUNT, AZURE_COSMOS_DB_MONGODB_RU_ACCOUNT, AZURE_COSMOS_DB_CASSANDRA_RU_ACCOUNT, AZURE_COSMOS_DB_GREMLIN_ACCOUNT, AZURE_COSMOS_DB_TABLE_ACCOUNT, AZURE_SQL_DATABASE, AZURE_POSTGRESQL_SERVER, AZURE_MY_SQL_SERVER, AZURE_MY_SQL_SERVER_FLEXIBLE, AZURE_POSTGRESQL_SERVER_FLEXIBLE, AMAZON_EC2_VIRTUAL_MACHINE, AMAZON_S3_STORAGE, AMAZON_RDS, AMAZON_DYNAMO_DB, AMAZON_DOCUMENT_DB, M365_ONE_DRIVE_APP, M365_EXCHANGE_APP, M365_TEAMS_APP, M365_SHAREPOINT_APP, AMAZON_ELASTIC_KUBERNETES_SERVICE, AMAZON_FSX_FILE_SYSTEM, GOOGLE_CLOUD_VIRTUAL_MACHINE, GOOGLE_CLOUD_SQL_DATABASE, GOOGLE_CLOUD_BIG_QUERY_DATABASE, GOOGLE_CLOUD_ALLOY_DB_DATABASE, GOOGLE_CLOUD_FILE_STORAGE, GOOGLE_CLOUD_SPANNER, AZURE_DATA_LAKE_STORAGE, AMAZON_RDS_MARIA_DB, AMAZON_RDS_MY_SQL_DB, AMAZON_RDS_SQL_SERVER_DB, AMAZON_RDS_POSTGRESQL_DB, AMAZON_AURORA_MY_SQL_DB, AMAZON_AURORA_POSTGRESQL_DB, AMAZON_REDSHIFT, AMAZON_RDS_ORACLE_DB, AMAZON_RDS_DB2_DB, AMAZON_ELASTIC_FILE_SYSTEM]

  • description string
  • workloads object[]
  • solution object

    solution details

  • id int32
  • name string
  • workload object

    workload details

  • id int32
  • name string
  • workloadOptions object
  • credential object
  • id int32
  • name string
  • isRapidRecovery boolean
  • isLongTermRetention boolean
  • commonOption object

    Common workload options

  • credential object

    Credential entity for workload access

  • id int32
  • name string
  • snapshotResourceGroup string

    Resource group for snapshot operations

  • dbOption object

    Database workload options

  • isRapidRecovery boolean

    Enable rapid recovery for database backups

  • isLongTermRetention boolean

    Enable long-term retention for database backups

  • filterWorkloads object[]
  • solution object

    solution details

  • id int32
  • name string
  • workload object

    workload details

  • id int32
  • name string
  • workloadOptions object
  • credential object
  • id int32
  • name string
  • isRapidRecovery boolean
  • isLongTermRetention boolean
  • commonOption object

    Common workload options

  • credential object

    Credential entity for workload access

  • id int32
  • name string
  • snapshotResourceGroup string

    Resource group for snapshot operations

  • dbOption object

    Database workload options

  • isRapidRecovery boolean

    Enable rapid recovery for database backups

  • isLongTermRetention boolean

    Enable long-term retention for database backups

  • plan object
  • id int32
  • name string
  • cloudAccounts object[]

    List of cloud accounts

  • name string

    cloud account name

  • id string

    cloud account id

  • uuid string

    The globally unique identifier for the account

  • email string

    email for cloud account

  • allCloudAccounts boolean
  • activityControl object
  • enableBackup boolean

    true if Backup is enabled

  • enableRestore boolean

    true if Restore is enabled

  • backupActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE, AUXCOP, DRBACKUP, MEDIARECYCLE, SYNTHETICFULL, ALLACTIVITY, SCHEDULE, OFFLINECI, DDBACTIVITY, DATAVERIFICATION, SENDLOGFILEACTIVITY]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • restoreActivityControlOptions object
  • activityType string

    Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE, AUXCOP, DRBACKUP, MEDIARECYCLE, SYNTHETICFULL, ALLACTIVITY, SCHEDULE, OFFLINECI, DDBACTIVITY, DATAVERIFICATION, SENDLOGFILEACTIVITY]

    denotes the activity type being considered

  • enableAfterADelay boolean

    True if the activity will be enabled after a delay time interval

  • enableActivityType boolean

    True if the activity type is enabled

  • delayTime object
  • timeZone object
  • id int32
  • name string
  • time int32

    delay time in unix timestamp

  • value string

    actual delay time value in string format according to the timezone

  • accessNodeList object
  • accessNodeMessage string
  • resourcePoolName string
  • accessNode object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • isScaleProfile boolean

    Default value: false

    True if the access node is a scale profile client

  • timeZone object
  • id int32
  • name string
Loading...