Get all the associated entities of backupdestination.

Select

SaaS

Customer Managed

Get all the associated server/server groups and included/excluded entities of backupdestination. It will also return summary of all the entities that will be auxcopied for backupdestination.

Path Parameters

• planId int32 required
• backupDestinationId int32 required

Query Parameters

• entityType int32

  It is to further filter and get all the child entities of given entityType/entityId associated with backupdestination.

• entityId int32

  It is to further filter and get all the child entities of given entityType/entityId associated with backupdestination.

Responses

• 200
• 404
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• associations object[]

  List all the entities of backupdestination.It includes all the server/server groups which can be picked for auxcopy, as well as all the included and excluded entities.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  flags object

  These flags are used to specify the type of association between the entity and the backupdestination.

  disabled boolean

  If set to true, the entity is disabled for current user.

  include boolean

  If set to true, this entity and its child entities are included for auxcopy

  exclude boolean

  If set to true, this entity and its child entities are excluded for auxcopy

  type string

  Possible values: [ALL_SERVERS, ALL_SERVER_GROUPS_ENTITY, SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY, SUBCLIENT_ENTITY]

  parentEntity1 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity2 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity3 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity4 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity5 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

• auxCopyAssociations object[]

  Summary of all the entities of backupdestination that will be auxcopied.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  flags object

  These flags are used to specify the type of association between the entity and the backupdestination.

  disabled boolean

  If set to true, the entity is disabled for current user.

  include boolean

  If set to true, this entity and its child entities are included for auxcopy

  exclude boolean

  If set to true, this entity and its child entities are excluded for auxcopy

  type string

  Possible values: [ALL_SERVERS, ALL_SERVER_GROUPS_ENTITY, SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY, SUBCLIENT_ENTITY]

  parentEntity1 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity2 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity3 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity4 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

  parentEntity5 object

  parentEntity1 can start from SERVER_ENTITY or SERVER_GROUP_ENTITY and subsequentily ending up at parentEntity4 or parentEntity5 with Backupset.

  id int32

  id of the associated entity

  name string

  name of the associated entity

  type string

  Possible values: [SERVER_GROUP_ENTITY, SERVER_ENTITY, APPTYPE_ENTITY, INSTANCE_ENTITY, BACKUPSET_ENTITY]

{
  "associations": [
    {
      "id": 0,
      "name": "string",
      "flags": {
        "disabled": true,
        "include": true,
        "exclude": true
      },
      "type": "ALL_SERVERS",
      "parentEntity1": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity2": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity3": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity4": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity5": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      }
    }
  ],
  "auxCopyAssociations": [
    {
      "id": 0,
      "name": "string",
      "flags": {
        "disabled": true,
        "include": true,
        "exclude": true
      },
      "type": "ALL_SERVERS",
      "parentEntity1": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity2": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity3": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity4": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      },
      "parentEntity5": {
        "id": 0,
        "name": "string",
        "type": "SERVER_GROUP_ENTITY"
      }
    }
  ]
}

Requested Details not found

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

GET /v4/plan/:planid/backupdestination/:backupdestinationid/associations    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

planId — path required

backupDestinationId — path required

entityType — query

entityId — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'