Skip to main content

Update all the included/excluded entities of backupdestination.​

Select

SaaS
Customer Managed

Update all the included/excluded entities of backupdestination.

Path Parameters
  • planId int32 required
  • backupDestinationId int32 required
Request Body
  • updateApplicableForFutureJobs boolean

    If set to true, then only future jobs will honour this update.

  • associations object[]

    List of selected/excluded entities to be associated with backup destination.

  • 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]

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/plan/:planid/backupdestination/:backupdestinationid/associations

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
planId — path required
backupDestinationId — path required
Body
{

  "updateApplicableForFutureJobs": true,

  "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"

      }

    }

  ]

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/Associations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "updateApplicableForFutureJobs": true,
  "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"
      }
    }
  ]
}'