Skip to content

Regions

GET
/api/shape/bot/namespaces/system/regions
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/system/regions \
--header 'Authorization: <Authorization>'

GET protected apps regions list.

Examples of this operation.

A successful response.

Media typeapplication/json
RegionsListResponse

Response for getting regions list.

object
regions
Regions

List of regions for protected applications.

Array<object>
Region Details

Region for protected application.

object
mobile_endpoint
object
telemetry_prefix
Telemetry Prefix

Telemetry Prefix for a region.

string
<= 1024 characters
url
API Hostname

API hostname for a region.

string format: uri
<= 1024 characters
region
string
default: US
Allowed values: US EU ASIA CA
web_endpoint
object
telemetry_prefix
Telemetry Prefix

Telemetry Prefix for a region.

string
<= 1024 characters
url
API Hostname

API hostname for a region.

string format: uri
<= 1024 characters
Example
{
"regions": [
{
"region": "US"
}
]
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example