List all Global IP Allowed Ports
Successful response
Array of objects (GlobalIPAllowedPort) | |
{- "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
}
]
}
{- "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.
Successful response
Unprocessable entity. Check the 'detail' field in response for details.
{- "ports": {
- "tcp": [
- 80,
- 8080
], - "udp": [
- 5000,
- 5050
]
}, - "name": "test interface",
- "description": "test interface"
}
{- "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.
Successful response
object (GlobalIP) | |||||||||||||||||
|
{- "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.
Successful response
object (GlobalIP) | |||||||||||||||||
|
{- "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"
}
}
{- "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.
Successful response
object (GlobalIpAssignment) | |||||||||||||||||||||
|
Unprocessable entity. Check the 'detail' field in response for details.
{- "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
- "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
- "is_in_maintenance": true
}
{- "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 assignment.
Successful response
object (GlobalIpAssignment) | |||||||||||||||||||||
|
{- "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.
Successful response
object (GlobalIpAssignment) | |||||||||||||||||||||
|
{- "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
- "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
- "is_in_maintenance": true
}
{- "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.
Successful response
object (GlobalIpAssignment) | |||||||||||||||||||||
|
{- "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
}
}