Regions

Region management operations

List regions

get

Lists regions

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters

parent_region_idstringOptional

Filter by parent region ID

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Regions listed successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get/regions

HTTPcURLJavaScriptPython

GET /keystone/v3/regions HTTP/1.1
Host: example.platform9.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"
  }
}

Create region

post

Creates a region

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

Region created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

409

This operation conflicted with another operation on this resource

application/json

post/regions

HTTPcURLJavaScriptPython

POST /keystone/v3/regions HTTP/1.1
Host: example.platform9.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"
    }
  }
}

Show region details

get

Shows details for a region

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

region_idstringRequired

The region ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

200

Region details retrieved successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get/regions/{region_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/regions/{region_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

{
  "region": {
    "id": "text",
    "description": "text",
    "parent_region_id": "text",
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Delete region

delete

Deletes a region

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

region_idstringRequired

The region ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Responses

204

Region deleted successfully

No content

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

delete/regions/{region_id}

HTTPcURLJavaScriptPython

DELETE /keystone/v3/regions/{region_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Update region

patch

Updates a region

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters

region_idstringRequired

The region ID

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

200

Region updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch/regions/{region_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/regions/{region_id} HTTP/1.1
Host: example.platform9.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"
    }
  }
}