Create a Public Internet Gateway

POST 
/public_internet_gateways

Create a new Public Internet Gateway.

Request

application/json

Body

required

network_id uuidrequired

The id of the network associated with the interface.

name string

A user specified name for the interface.

region_code string

The region the interface should be deployed to.

Responses

202: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Identifies the resource.

record_type string

Identifies the type of the resource.

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.

network_id uuid

The id of the network associated with the interface.

name string

A user specified name for the interface.

status InterfaceStatus (string)

Possible values: [created, provisioning, provisioned, deleting]

The current status of the interface deployment.

public_ip string

The publically accessible ip for this interface.

region_code string

The region interface is deployed to.

region

object

code string

Region code of the interface.

name string

Region name of the interface.

record_type string

Identifies the type of the resource.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "name": "test interface",
    "status": "provisioned",
    "public_ip": "127.0.0.1",
    "region_code": "ashburn-va",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    }
  }
}

422: Unprocessable entity. Check the 'detail' field in response for details.

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": {}
    }
  ]
}

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...