Skip to main content

Update Recovery Group​

Select

SaaS
Customer Managed

Update Recovery Group

Path Parameters
  • recoveryGroupId integer required

    Recovery group Id

Request Body
  • id int32

    Id of the recovery group

  • name string

    Name of the recovery group

  • target object
  • id int32
  • name string
  • postRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • delayBetweenPriorityMachines int32

    The delay between machines in different priorities in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure

  • action RecoveryAction

    Possible values: [CREATE, UPDATE, DELETE]

    Recovery Action

  • recoveryPointDetails object

    Contains the information regarding the recovery group level recoveryPoint selection

  • recoveryPoint int32

    Timestamp for group restore in case of disaster

  • recoveryPointCategory string

    Possible values: [LATEST, POINT_IN_TIME, AUTOMATIC]

    Default value: LATEST

    Type of recovery point category

  • recoveryPoint int32

    Timestamp for group restore in case of disaster

  • recoveryExpirationOptions object
  • enableExpirationOption boolean

    Default value: true

    If true, cleans up recovered VMs after the set daysToExpire value

  • daysToExpire int32

    Default value: 7

    Number of days after which recovered VMs are automatically cleaned up

  • isRescuedCommServe boolean

    Whether the CommServe is rescued or not

  • expirationTime int32

    Timestamp when the clean up of all recovered VMs happens on the rescued CommServe. It happens 4 hours before the CommServe expiration time

Responses

OK

Schema
  • recoveryGroup object
  • id int32
  • name string
  • error object
  • errorMessage string
  • errorCode int32
PUT /recoverygroup/:recoverygroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "id": 0,

  "name": "string",

  "target": {

    "id": 0,

    "name": "string"

  },

  "postRecoveryActions": [

    {

      "path": "string",

      "type": "UNC",

      "scriptCredentials": {

        "savedCredentials": {

          "id": 0,

          "name": "string"

        },

        "credentials": {

          "name": "string",

          "password": "string"

        }

      },

      "guestCredentials": {

        "savedCredentials": {

          "id": 0,

          "name": "string"

        },

        "credentials": {

          "name": "string",

          "password": "string"

        }

      },

      "guid": "string",

      "scriptContent": "string",

      "scriptName": "string",

      "reset": true,

      "osType": "WINDOWS"

    }

  ],

  "delayBetweenPriorityMachines": 0,

  "continueOnFailure": false,

  "recoveryPointDetails": {

    "recoveryPoint": 0,

    "recoveryPointCategory": "LATEST"

  },

  "recoveryPoint": 0,

  "recoveryExpirationOptions": {

    "enableExpirationOption": true,

    "daysToExpire": 7,

    "isRescuedCommServe": true,

    "expirationTime": 0

  }

}
Accept
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/RecoveryGroup/:recoveryGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "id": 0,
  "name": "string",
  "target": {
    "id": 0,
    "name": "string"
  },
  "postRecoveryActions": [
    {
      "path": "string",
      "type": "UNC",
      "scriptCredentials": {
        "savedCredentials": {
          "id": 0,
          "name": "string"
        },
        "credentials": {
          "name": "string",
          "password": "string"
        }
      },
      "guestCredentials": {
        "savedCredentials": {
          "id": 0,
          "name": "string"
        },
        "credentials": {
          "name": "string",
          "password": "string"
        }
      },
      "guid": "string",
      "scriptContent": "string",
      "scriptName": "string",
      "reset": true,
      "osType": "WINDOWS"
    }
  ],
  "delayBetweenPriorityMachines": 0,
  "continueOnFailure": false,
  "recoveryPointDetails": {
    "recoveryPoint": 0,
    "recoveryPointCategory": "LATEST"
  },
  "recoveryPoint": 0,
  "recoveryExpirationOptions": {
    "enableExpirationOption": true,
    "daysToExpire": 7,
    "isRescuedCommServe": true,
    "expirationTime": 0
  }
}'