Public Internet Gateways API

Public Internet Gateway operations

List all Public Internet Gateways

List all Public Internet Gateways.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[network_id]
string

The associated network id to filter on.

Example: filter[network_id]=6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
Array of objects (PublicInternetGatewayRead)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/public_internet_gateways
Request samples 
Response samples 
application/json
{
  • "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",
        • "name": "Ashburn",
        • "record_type": "region"
        },
      • "region_code": "ashburn-va"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Create a Public Internet Gateway
Create a new Public Internet Gateway.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
region_code
string
The region the interface should be deployed to.


 
Responses 
202
Successful response


Response Schema: application/json
object (PublicInternetGatewayRead) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


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


 
name
string
A user specified name for the interface.


 
network_id
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
public_ip
string
The publically accessible ip for this interface.


 
object
 
region_code
string
The region interface is deployed to.


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


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/public_internet_gateways
Request samples 
application/json
{
  • "name": "test interface",
  • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  • "region_code": "ashburn-va"
}
Response samples 
application/json
{
  • "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",
      • "name": "Ashburn",
      • "record_type": "region"
      },
    • "region_code": "ashburn-va"
    }
}
Delete a Public Internet Gateway
Delete a Public Internet Gateway.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (PublicInternetGatewayRead) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


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


 
name
string
A user specified name for the interface.


 
network_id
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
public_ip
string
The publically accessible ip for this interface.


 
object
 
region_code
string
The region interface is deployed to.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/public_internet_gateways/{id}
Request samples 
Response samples 
application/json
{
  • "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",
      • "name": "Ashburn",
      • "record_type": "region"
      },
    • "region_code": "ashburn-va"
    }
}
Retrieve a Public Internet Gateway
Retrieve a Public Internet Gateway.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (PublicInternetGatewayRead) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


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


 
name
string
A user specified name for the interface.


 
network_id
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
public_ip
string
The publically accessible ip for this interface.


 
object
 
region_code
string
The region interface is deployed to.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/public_internet_gateways/{id}
Request samples 
Response samples 
application/json
{
  • "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",
      • "name": "Ashburn",
      • "record_type": "region"
      },
    • "region_code": "ashburn-va"
    }
}