Set Region for an entity

Api to set region for an entity.

Path Parameters

• entityType string required

  Possible values: [COMMCELL, CLIENT, INSTANCE, BACKUPSET, SUBCLIENT, CLIENT_GROUP, USER, USER_GROUP, LIBRARY, MEDIAAGENT, RESOURCEPOOL, STORAGE_POOL, STORAGE_POLICY, SCHEDULE_POLICY, SUBCLIENT_POLICY, ALERT, PLAN, VIRTUAL_MACHINE, ROLE, DEVICE, REGION, NETWORK_TOPOLOGY, COMPANY]

  Type of the entity

• entityId int32 required

  Possible values: >= 1

  Unique id for the entity

application/json

Request Body

• entityRegionType string

  Possible values: [BACKUP, WORKLOAD]

• region object

  id int32

  name string

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

PUT /v4/entity/:entitytype/:entityid/region    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

entityType — path required

---COMMCELLCLIENTINSTANCEBACKUPSETSUBCLIENTCLIENT_GROUPUSERUSER_GROUPLIBRARYMEDIAAGENTRESOURCEPOOLSTORAGE_POOLSTORAGE_POLICYSCHEDULE_POLICYSUBCLIENT_POLICYALERTPLANVIRTUAL_MACHINEROLEDEVICEREGIONNETWORK_TOPOLOGYCOMPANY

entityId — path required

Body

{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/entity/:entityType/:entityId/region' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entityRegionType": "BACKUP",
  "region": {
    "id": 0,
    "name": "string"
  }
}'