Gateway
UpCloud Gateway API. Allows creation, management and deletion of gateways.
Replace Service
Replace service configuration.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Replace Service › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the service
configured_statusService configured status
planPlan
connectionsService connections
Labels
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Replace Service › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the service
zone^[a-zA-Z0-9_-]+$Zone of the service
plan^[a-zA-Z0-9_-]+$Plan
featuresActive features
Response schema for gateway router details.
configured_statusService configured status
operational_stateService operational state
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Labels
created_atTimestamp of when the service was created.
updated_atTimestamp of when the service was last updated.
Delete Service
Deletes existing service by given {service-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Delete Service › Responses
No Content
Modify Service
Modify service configuration.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Modify Service › Request Body
name^[a-zA-Z0-9_-]+$Name of the service
featuresActive features
planPlan
configured_statusService configured status
Service connections
Labels
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Modify Service › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the service
zone^[a-zA-Z0-9_-]+$Zone of the service
plan^[a-zA-Z0-9_-]+$Plan
featuresActive features
Response schema for gateway router details.
configured_statusService configured status
operational_stateService operational state
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Labels
created_atTimestamp of when the service was created.
updated_atTimestamp of when the service was last updated.
List Plans
List available plans.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
List Plans › Responses
OK
Response schema for a list of gateway plans.
name^[a-zA-Z0-9_-]+$Name of the plan
server_numberNumber of nodes
per_gateway_max_connectionsPer gateway (agent node server) maximum conntrack connections
supported_featuresvpn_tunnel_amountNumber of VPN tunnels this plan allows.
per_gateway_bandwidth_mbpsPer gateway (agent node server) bandwidth in megabits per second.
per_gateway_maximum_vpn_bandwidth_mbpsPer gateway (agent node server) maximum vpn bandwidth in megabits per second.
Get Plan Details
Get plan details.
path Parameters
plan-name^[a-zA-Z0-9_-]+$ · requiredPlan identifier
The name for the resource.
Get Plan Details › Responses
OK
name^[a-zA-Z0-9_-]+$Name of the plan
server_numberNumber of nodes
per_gateway_max_connectionsPer gateway (agent node server) maximum conntrack connections
supported_featuresvpn_tunnel_amountNumber of VPN tunnels this plan allows.
per_gateway_bandwidth_mbpsPer gateway (agent node server) bandwidth in megabits per second.
per_gateway_maximum_vpn_bandwidth_mbpsPer gateway (agent node server) maximum vpn bandwidth in megabits per second.
List Services
List available services.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
sortSort resources by field. Prefix with '-' for descending order.
Sort services by field. Prefix with '-' for descending order.
List Services › Responses
OK
Response schema for a list of gateway services.
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the service
zone^[a-zA-Z0-9_-]+$Zone of the service
plan^[a-zA-Z0-9_-]+$Plan
featuresActive features
Response schema for gateway router details.
configured_statusService configured status
operational_stateService operational state
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Labels
created_atTimestamp of when the service was created.
updated_atTimestamp of when the service was last updated.
Create Service
Create a new service.
Create Service › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the service
planPlan
zone^[a-z]{2}-[a-z]{3}\d… · requiredZone
featuresActive features
Service routers
configured_statusService configured status
Service addresses
Service connections
Labels
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Create Service › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the service
zone^[a-zA-Z0-9_-]+$Zone of the service
plan^[a-zA-Z0-9_-]+$Plan
featuresActive features
Response schema for gateway router details.
configured_statusService configured status
operational_stateService operational state
automatic_tunnel_internal_ip_allocationAllocate and use tunnel internal IPs automatically
Labels
created_atTimestamp of when the service was created.
updated_atTimestamp of when the service was last updated.
Flush NAT
Flush NAT rules.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Flush NAT › Responses
No Content
List Connections
List available connections for service.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
List Connections › Responses
OK
Response schema for a list of gateway connections.
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the connection
typeConnection type
Local routes for the connection
Remote routes for the connection
created_atTimestamp of when the connection was created.
updated_atTimestamp of when the connection was last updated.
Create Connection
Create a new connection.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Create Connection › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the connection
typeConnection type
uuidThe unique identifier for the resource.
Connection local routes
Connection remote routes
Connection tunnels
Create Connection › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the connection
typeConnection type
Local routes for the connection
Remote routes for the connection
created_atTimestamp of when the connection was created.
updated_atTimestamp of when the connection was last updated.
Get Connection Details
Get connection details.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
Get Connection Details › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the connection
typeConnection type
Local routes for the connection
Remote routes for the connection
created_atTimestamp of when the connection was created.
updated_atTimestamp of when the connection was last updated.
Delete Connection
Deletes existing connection by given {connection-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
Delete Connection › Responses
No Content
Modify Connection
Modify connection configuration.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
Modify Connection › Request Body
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the connection
typeConnection type
Connection local routes
Connection remote routes
Tunnels
Modify Connection › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the connection
typeConnection type
Local routes for the connection
Remote routes for the connection
created_atTimestamp of when the connection was created.
updated_atTimestamp of when the connection was last updated.
List Tunnels
List available tunnels for service.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
List Tunnels › Responses
OK
Response schema for a list of gateway tunnels.
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the tunnel
Response schema for local peer address details.
Response schema for remote peer address details.
Response schema for IPsec configuration details.
Response schema for gateway tunnel internal IP details.
internal_peer_ping_intervalInternal peer ping interval in seconds
operational_stateTunnel operational state
created_atTimestamp of when the tunnel was created.
updated_atTimestamp of when the tunnel was last updated.
tunnel_upIndicates whether the tunnel is up
tunnel_healthyIndicates whether the tunnel is healthy
Create Tunnel
Create a new tunnel.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
Create Tunnel › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the tunnel
Local peer address
Remote peer address
IPsec configuration
uuidThe unique identifier for the resource.
tunnel_internal_ipTunnel internal IP address, "" if disabled
internal_peer_ping_intervalInternal peer ping interval in seconds, or zero if disabled
Create Tunnel › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the tunnel
Response schema for local peer address details.
Response schema for remote peer address details.
Response schema for IPsec configuration details.
Response schema for gateway tunnel internal IP details.
internal_peer_ping_intervalInternal peer ping interval in seconds
operational_stateTunnel operational state
created_atTimestamp of when the tunnel was created.
updated_atTimestamp of when the tunnel was last updated.
tunnel_upIndicates whether the tunnel is up
tunnel_healthyIndicates whether the tunnel is healthy
Get Tunnel Details
Get tunnel details.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
tunnel-uuidTunnel UUID
The unique identifier for the resource.
Get Tunnel Details › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the tunnel
Response schema for local peer address details.
Response schema for remote peer address details.
Response schema for IPsec configuration details.
Response schema for gateway tunnel internal IP details.
internal_peer_ping_intervalInternal peer ping interval in seconds
operational_stateTunnel operational state
created_atTimestamp of when the tunnel was created.
updated_atTimestamp of when the tunnel was last updated.
tunnel_upIndicates whether the tunnel is up
tunnel_healthyIndicates whether the tunnel is healthy
Delete Tunnel
Deletes existing tunnel by given {tunnel-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
tunnel-uuidTunnel UUID
The unique identifier for the resource.
Delete Tunnel › Responses
No Content
Modify Tunnel
Modify tunnel configuration.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
connection-uuidConnection UUID
The unique identifier for the resource.
tunnel-uuidTunnel UUID
The unique identifier for the resource.
Modify Tunnel › Request Body
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the tunnel
Local peer address
Remote peer address
IPsec configuration
tunnel_internal_ipTunnel internal IP address, "" if disabled
internal_peer_ping_intervalInternal peer ping interval in seconds, or zero if disabled
Modify Tunnel › Responses
OK
uuidThe unique identifier for the resource.
name^[a-zA-Z0-9_-]+$Name of the tunnel
Response schema for local peer address details.
Response schema for remote peer address details.
Response schema for IPsec configuration details.
Response schema for gateway tunnel internal IP details.
internal_peer_ping_intervalInternal peer ping interval in seconds
operational_stateTunnel operational state
created_atTimestamp of when the tunnel was created.
updated_atTimestamp of when the tunnel was last updated.
tunnel_upIndicates whether the tunnel is up
tunnel_healthyIndicates whether the tunnel is healthy
List Service Labels
List available service labels for service.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
List Service Labels › Responses
OK
Response schema for a list of service labels.
key^[\x20-\x5E\x60-\x7E… · requiredKey
value\A[\p{L}\p{N}\p{P}\p… · requiredValue
Create Service Label
Create a new service label.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Create Service Label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredThe key of a label.
value\A[\p{L}\p{N}\p{P}\p… · requiredThe value of a label.
Create Service Label › Responses
Created
Get Service Label Details
Get service label details.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel identifier
The key of a label.
Get Service Label Details › Responses
OK
key^[\x20-\x5E\x60-\x7E… · requiredKey
value\A[\p{L}\p{N}\p{P}\p… · requiredValue
Delete Service Label
Deletes existing service label by given {service-label-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel identifier
The key of a label.
Delete Service Label › Responses
No Content
Modify Service Label
Modify service label configuration.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel identifier
The key of a label.
Modify Service Label › Request Body
key^[\x20-\x5E\x60-\x7E…The key of a label.
value\A[\p{L}\p{N}\p{P}\p…The value of a label.
Modify Service Label › Responses
OK
List Service Addresses
List available service addresses for service.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
List Service Addresses › Responses
OK
Response schema for a list of gateway addresses.
name^[a-zA-Z0-9_-]+$Name of the address
addressVPN address
provisioned_byProvisioner of the address
Create Service Address
Create a new service address.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Create Service Address › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the address
addressFloating IP address
Create Service Address › Responses
Created
name^[a-zA-Z0-9_-]+$Name of the address
addressVPN address
provisioned_byProvisioner of the address
Get Service Address Details
Get service address details.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
address-name^[a-zA-Z0-9_-]+$ · requiredAddress identifier
The name for the resource.
Get Service Address Details › Responses
OK
name^[a-zA-Z0-9_-]+$Name of the address
addressVPN address
provisioned_byProvisioner of the address
Delete Service Address
Deletes existing service address by given {service-address-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
address-name^[a-zA-Z0-9_-]+$ · requiredAddress identifier
The name for the resource.
Delete Service Address › Responses
No Content
Modify Service Address
Modify existing service address by given {service-address-identifier}.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
address-name^[a-zA-Z0-9_-]+$ · requiredAddress identifier
The name for the resource.
Modify Service Address › Request Body
addressFloating IP address
Modify Service Address › Responses
OK
name^[a-zA-Z0-9_-]+$Name of the address
addressVPN address
provisioned_byProvisioner of the address
Get Service Metrics
List available service metrics for service.
path Parameters
service-uuidService UUID
The unique identifier for the resource.
Get Service Metrics › Responses
OK
Response schema for IPsec IKE SA metrics details.