Regions
Region management operations
Lists regions
Authentication token obtained from the authentication service
Filter by parent region ID
Requests a page size of items
The ID of the last-seen item for pagination
A valid authentication token
Regions listed successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
GET /v3/regions HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"regions": [
{
"id": "text",
"description": "text",
"parent_region_id": "text",
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
],
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}Creates a region
Authentication token obtained from the authentication service
A valid authentication token
Region created successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
This operation conflicted with another operation on this resource
POST /v3/regions HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"region": {
"id": "text",
"description": "text",
"parent_region_id": "text"
}
}{
"region": {
"id": "text",
"description": "text",
"parent_region_id": "text",
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Shows details for a region
Authentication token obtained from the authentication service
The region ID
A valid authentication token
Region details retrieved successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
GET /v3/regions/{region_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
"region": {
"id": "text",
"description": "text",
"parent_region_id": "text",
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Deletes a region
Authentication token obtained from the authentication service
The region ID
A valid authentication token
Region deleted successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
DELETE /v3/regions/{region_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
No content
Updates a region
Authentication token obtained from the authentication service
The region ID
A valid authentication token
Region updated successfully
Some content in the request was invalid
User must authenticate before making a request
Policy does not allow current user to do this operation
The requested resource could not be found
This operation conflicted with another operation on this resource
PATCH /v3/regions/{region_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"region": {
"id": "text",
"description": "text",
"parent_region_id": "text"
}
}{
"region": {
"id": "text",
"description": "text",
"parent_region_id": "text",
"links": {
"self": "text",
"previous": "text",
"next": "text"
}
}
}Last updated
Was this helpful?