List all Regions

GET 
/regions

List all regions and the interfaces that region supports

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Identifies the type of the resource.

code string

A code for the region.

name string

A name for the region.

supported_interfaces string[]

List of interface types supported in this region.

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was updated.

]

{
  "data": [
    {
      "record_type": "region",
      "code": "ashburn-va",
      "name": "Ashburn",
      "supported_interfaces": [
        "wireguard_interface"
      ],
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...