Create Region

Select

SaaS

Customer Managed

Create a region

application/json

Request Body

• name string required

  Region name

• type string

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

  Default value: USER_CREATED

  Type of the region

• locations object[] required

  Possible values: >= 1

  List of locations which are part of the region

  city string

  Name of city

  state string

  Name of state

  country string required

  Name of country

  latitude double required

  Latitude for the location

  longitude double required

  Longitude for the location

• globalConfigInfo object

  Only applicable to Global CommCells. Not applicable for SaaS.

  name string

  commcells object[]

  List of Service CommCells where the global configuration should be applied

  id int32

  name string

  guid string

  scope string

  The entity level at which the config has to be applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string using for filtering the scope

  applyOnAllCommCells boolean

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

  actionOnLocalEntity string

  Possible values: [CREATE_NEW, TAKE_OVER, FAIL_IF_EXIST]

  Action that will be taken on the local entity that has the same name as the global entity that needs to be created

Responses

• 200
• 400
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id int32
• GUID string
• name string

{
  "id": 0,
  "GUID": "string",
  "name": "string"
}

Bad Request

Region with same name already exists

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

Internal Server Error

POST /v4/regions    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Regions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "type": "USER_CREATED",
  "locations": [
    {
      "city": "string",
      "state": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'