Skip to main content

Get list of eligible source copies for given region id​

Gives a list of eligible source copies for given region id

Path Parameters
  • planId integer required

    Id of plan

Query Parameters
  • regionId integer

    Region Id against which we want to check eligible source copies. Skip if no region present.

  • forSnapCopy boolean

    Get list of source copy eligible for snap copy in given region.

Responses

OK

Schema
  • copy object[]

    List of backup destinations which can act as source copy for a new copy

  • isDefault boolean

    Is this a default backup destination?

  • isActive boolean

    Is this an active backup destination?

  • isSnapCopy boolean

    Is this a snap copy?

  • isMirrorCopy boolean

    Is this a mirror copy?

  • copyType

    Possible values: [SYNCHRONOUS, SELECTIVE]

  • snapCopyType

    Possible values: [DEFAULT_MIRROR, DEFAULT_VAULT_REPLICA, MIRROR, VAULT_REPLICA, SNAPSHOT_PRIMARY]

  • copyPrecedence int32

    Order of backup destinaion copy created in storage policy

  • backupDestination object
  • id int32
  • name string
  • arrayReplicaCopy boolean

    Is this an array replica copy?

  • defaultReplicaCopy boolean

    Is this a default replica copy?

GET /v5/serverplan/:planid/backupdestination/sourcecopy/eligible

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
planId — path required
regionId — query
forSnapCopy — query
curl -L -X GET 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/SourceCopy/Eligible' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'