Skip to main content

Get Region Details of entity​

Select

SaaS
Customer Managed

Api to fetch region details 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

Query Parameters
  • calculate boolean

    Flag for Enable/Disable Region Calculation

  • entityRegionType string

    Possible values: [BACKUP, WORKLOAD]

    Region Type Enum

Responses

OK

Schema
  • id int32
  • name string
  • displayName string
GET /v4/entity/:entitytype/:entityid/region

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
entityType — path required
entityId — path required
calculate — query
entityRegionType — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/entity/:entityType/:entityId/region' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'