Sign in
Public Internet Gateways

Create a Public Internet Gateway

Requests creation of a public internet gateway on the specified network, giving the network internet egress. Creation is asynchronous, so the request is accepted and completes in the background.

post/public_internet_gateways

Request body

created_atstring

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

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

updated_atstring

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

namestring

A user specified name for the interface.

network_idstring uuid

The id of the network associated with the interface.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

public_ipstring

The publically accessible ip for this interface.

region_codestring

The region interface is deployed to.

Example request

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

Response

Creation request accepted. Provisioning is asynchronous; poll GET /public_internet_gateways/{id} with the returned id to check status.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.4

  • 1571b0380bd72See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog