Skip to main content

Get Regions

Select

SaaS
Customer Managed

Get list of regions

Query Parameters
  • type RegionType

    Possible values: [DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

    Region type to be filtered

Responses

OK


Schema
  • regions object[]

    Regions list

  • id int32
  • name string
  • displayName string
  • regionType RegionType

    Possible values: [DEFAULT, AZURE, AWS, USER_CREATED, OCI, GCP]

    Type of region

  • locations object[]

    Possible values: >= 1

    List of locations in the region

  • city string
  • state string
  • country string
  • associatedServers int32

    Number of servers associated to the region

  • associatedRegionBasedPlans int32

    Number of plans associated to the region

  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
Loading...