Global IPs

Global IPs

List all Global IP Protocols

List all Global IP Protocols

SecurityBearerAuth
Responses
200

Successful response

Response Schema: application/json
Array of objects (GlobalIPProtocol)
Array
record_type
string

Identifies the type of the resource.

code
string

The Global IP Protocol code.

name
string

A name for Global IP Protocol.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
title
required
string
detail
string
object
meta
object
get/global_ip_protocols
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "record_type": "global_ip_protocol",
      • "code": "tcp",
      • "name": "TCP"
      }
    ]
}
List all Global IP Allowed Ports
List all Global IP Allowed Ports


SecurityBearerAuth 
Responses 
200
Successful response


Response Schema: application/json
Array of objects (GlobalIPAllowedPort) 
 
 Array 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
protocol_code
string
The Global IP Protocol code.


 
name
string
A name for the Global IP ports range.


 
first_port
integer
First port of a range.


 
last_port
integer
Last port of a range.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/global_ip_allowed_ports
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "global_ip_allowed_port",
      • "protocol_code": "tcp",
      • "name": "TCP Registered",
      • "first_port": 1024,
      • "last_port": 49151
      }
    ]
}
List all Global IPs
List all Global IPs.


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


 
Responses 
200
Successful response


Response Schema: application/json
Array of objects (GlobalIP) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/global_ips
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "global_ip",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "ip_address": "198.51.100.1",
      • "ports": {
        • "tcp": [
          • 80,
          • 8080
          ],
        • "udp": [
          • 5000,
          • 5050
          ]
        },
      • "name": "test interface",
      • "description": "test interface"
      }
    ],
  • "meta": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}
Create a Global IP
Create a Global IP.


SecurityBearerAuth 
Request 
Request Body schema: application/json
ports
object
A Global IP ports grouped by protocol code.


 
name
string
A user specified name for the address.


 
description
string
A user specified description for the address.


 
Responses 
202
Successful response


Response Schema: application/json
object (GlobalIP) 
 
id
string <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.


 
ip_address
string
The Global IP address.


 
ports
object
A Global IP ports grouped by protocol code.


 
name
string
A user specified name for the address.


 
description
string
A user specified description for the address.


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


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


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/global_ips
Request samples 
application/json
{
  • "ports": {
    • "tcp": [
      • 80,
      • 8080
      ],
    • "udp": [
      • 5000,
      • 5050
      ]
    },
  • "name": "test interface",
  • "description": "test interface"
}
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "ip_address": "198.51.100.1",
    • "ports": {
      • "tcp": [
        • 80,
        • 8080
        ],
      • "udp": [
        • 5000,
        • 5050
        ]
      },
    • "name": "test interface",
    • "description": "test interface"
    }
}
Retrieve a Global IP
Retrieve a Global IP.


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 (GlobalIP) 
 
id
string <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.


 
ip_address
string
The Global IP address.


 
ports
object
A Global IP ports grouped by protocol code.


 
name
string
A user specified name for the address.


 
description
string
A user specified description for the address.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/global_ips/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "ip_address": "198.51.100.1",
    • "ports": {
      • "tcp": [
        • 80,
        • 8080
        ],
      • "udp": [
        • 5000,
        • 5050
        ]
      },
    • "name": "test interface",
    • "description": "test interface"
    }
}
Delete a Global IP
Delete a Global IP.


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 (GlobalIP) 
 
id
string <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.


 
ip_address
string
The Global IP address.


 
ports
object
A Global IP ports grouped by protocol code.


 
name
string
A user specified name for the address.


 
description
string
A user specified description for the address.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
delete/global_ips/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "ip_address": "198.51.100.1",
    • "ports": {
      • "tcp": [
        • 80,
        • 8080
        ],
      • "udp": [
        • 5000,
        • 5050
        ]
      },
    • "name": "test interface",
    • "description": "test interface"
    }
}
List all Global IP assignments
List all Global IP assignments.


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


 
Responses 
200
Successful response


Response Schema: application/json
Array of objects (GlobalIpAssignment) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/global_ip_assignments
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "global_ip_assignment",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
      • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
      • "status": "provisioned",
      • "is_connected": true,
      • "is_in_maintenance": true,
      • "is_announced": true
      }
    ],
  • "meta": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}
Create a Global IP assignment
Create a Global IP assignment.


SecurityBearerAuth 
Request 
Request Body schema: application/json
global_ip_id
string <uuid> 
Global IP ID.


 
wireguard_peer_id
string <uuid> 
Wireguard peer ID.


 
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
Responses 
202
Successful response


Response Schema: application/json
object (GlobalIpAssignment) 
 
id
string <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.


 
global_ip_id
string <uuid> 
Global IP ID.


 
wireguard_peer_id
string <uuid> 
Wireguard peer ID.


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


 Enum: "created" "provisioning" "provisioned" "deleting"  
is_connected
boolean
Wireguard peer is connected.


 
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
is_announced
boolean
Status of BGP announcement.


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


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


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/global_ip_assignments
Request samples 
application/json
{
  • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
  • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
  • "is_in_maintenance": true
}
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip_assignment",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    • "status": "provisioned",
    • "is_connected": true,
    • "is_in_maintenance": true,
    • "is_announced": true
    }
}
Retrieve a Global IP
Retrieve a Global IP assignment.


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 (GlobalIpAssignment) 
 
id
string <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.


 
global_ip_id
string <uuid> 
Global IP ID.


 
wireguard_peer_id
string <uuid> 
Wireguard peer ID.


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


 Enum: "created" "provisioning" "provisioned" "deleting"  
is_connected
boolean
Wireguard peer is connected.


 
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
is_announced
boolean
Status of BGP announcement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/global_ip_assignments/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip_assignment",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    • "status": "provisioned",
    • "is_connected": true,
    • "is_in_maintenance": true,
    • "is_announced": true
    }
}
Update a Global IP assignment
Update a Global IP assignment.


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


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
Responses 
200
Successful response


Response Schema: application/json
object (GlobalIpAssignment) 
 
id
string <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.


 
global_ip_id
string <uuid> 
Global IP ID.


 
wireguard_peer_id
string <uuid> 
Wireguard peer ID.


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


 Enum: "created" "provisioning" "provisioned" "deleting"  
is_connected
boolean
Wireguard peer is connected.


 
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
is_announced
boolean
Status of BGP announcement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
patch/global_ip_assignments/{id}
Request samples 
application/json
{
  • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
  • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
  • "is_in_maintenance": true
}
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip_assignment",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    • "status": "provisioned",
    • "is_connected": true,
    • "is_in_maintenance": true,
    • "is_announced": true
    }
}
Delete a Global IP assignment
Delete a Global IP assignment.


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 (GlobalIpAssignment) 
 
id
string <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.


 
global_ip_id
string <uuid> 
Global IP ID.


 
wireguard_peer_id
string <uuid> 
Wireguard peer ID.


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


 Enum: "created" "provisioning" "provisioned" "deleting"  
is_connected
boolean
Wireguard peer is connected.


 
is_in_maintenance
boolean
Enable/disable BGP announcement.


 
is_announced
boolean
Status of BGP announcement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
delete/global_ip_assignments/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "global_ip_assignment",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    • "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    • "status": "provisioned",
    • "is_connected": true,
    • "is_in_maintenance": true,
    • "is_announced": true
    }
}