How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
UpCloud

UpCloud Gateway API

UpCloud Gateway API. Allows creation, management and deletion of gateways.

Documentation Provider Profile APIs.io OpenAPI GitHub

UpCloud Gateway API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 16 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

30 operations 16 paths 59 schemas 4 DELETE13 GET6 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
UpCloud
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

UpCloud Gateway API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 30

Across 16 paths, the API surfaces 30 operations — 4 DELETE, 13 GET, 6 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Gateway 30

UpCloud Gateway API. Allows creation, management and deletion of gateways.

GET
/1.3/gateway/plans
List Plans
listGatewayPlans 2 params → 200default
GET
/1.3/gateway/plans/{plan-name}
Get Plan Details
getGatewayPlan 1 param → 200default
GET
/1.3/gateway
List Services
listGatewayServices 3 params → 200default
POST
/1.3/gateway
Create Service
createGatewayService body → 200default
GET
/1.3/gateway/{service-uuid}
Get Service Details
getGatewayService 1 param → 200default
PUT
/1.3/gateway/{service-uuid}
Replace Service
replaceGatewayService 1 param body → 200default
DELETE
/1.3/gateway/{service-uuid}
Delete Service
deleteGatewayService 1 param → 204default
PATCH
/1.3/gateway/{service-uuid}
Modify Service
modifyGatewayService 1 param body → 200default
PATCH
/1.3/gateway/{service-uuid}/actions/nat-flush-connections
Flush NAT
flushGatewayNat 1 param → 200default
GET
/1.3/gateway/{service-uuid}/connections
List Connections
listGatewayConnections 1 param → 200default
POST
/1.3/gateway/{service-uuid}/connections
Create Connection
createGatewayConnection 1 param body → 200default
GET
/1.3/gateway/{service-uuid}/connections/{connection-uuid}
Get Connection Details
getGatewayConnection 2 params → 200default
DELETE
/1.3/gateway/{service-uuid}/connections/{connection-uuid}
Delete Connection
deleteGatewayConnection 2 params → 204default
PATCH
/1.3/gateway/{service-uuid}/connections/{connection-uuid}
Modify Connection
modifyGatewayConnection 2 params body → 200default
GET
/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels
List Tunnels
listGatewayTunnels 2 params → 200default
POST
/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels
Create Tunnel
createGatewayTunnel 2 params body → 200default
GET
/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}
Get Tunnel Details
getGatewayTunnel 3 params → 200default
DELETE
/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}
Delete Tunnel
deleteGatewayTunnel 3 params → 204default
PATCH
/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}
Modify Tunnel
modifyGatewayTunnel 3 params body → 200default
GET
/1.3/gateway/{service-uuid}/labels
List Service Labels
listGatewayServiceLabels 1 param → 200default
POST
/1.3/gateway/{service-uuid}/labels
Create Service Label
createGatewayServiceLabel 1 param body → 201default
GET
/1.3/gateway/{service-uuid}/labels/{label-key}
Get Service Label Details
getGatewayServiceLabel 2 params → 200default
DELETE
/1.3/gateway/{service-uuid}/labels/{label-key}
Delete Service Label
deleteGatewayServiceLabel 2 params → 204default
PATCH
/1.3/gateway/{service-uuid}/labels/{label-key}
Modify Service Label
modifyGatewayServiceLabel 2 params body → 200default
GET
/1.3/gateway/{service-uuid}/addresses
List Service Addresses
listGatewayAddresses 1 param → 200default
GET
/1.3/gateway/{service-uuid}/addresses/{address-name}
Get Service Address Details
getGatewayAddress 2 params → 200default
PATCH
/1.3/gateway/{service-uuid}/addresses/{address-name}
Modify Service Address
modifyGatewayAddress 2 params body → 200default
POST
/1.3/gateway/{service-uuid}/addresses/{address-name}/release
Release Gateway Floating IP
releaseGatewayFloatingIp 2 params → 202default
GET
/1.3/gateway/{service-uuid}/metrics
Get Service Metrics
getGatewayMetrics 1 param → 200default
POST
/1.3/gateway/{service-uuid}/logs
Create Service Log Session
createGatewayServiceLogSession 1 param body → 200default

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are gatewayIpsecIkeSaMetricsDetailsResponse (18 properties), gatewayServiceDetailsResponse (14 properties), gatewayTunnelDetailsResponse (12 properties), gatewayIpsecDetailsResponse (12 properties). Each schema is shown below with its type and property counts.

gatewayServiceFeatures
string
Service features
gatewayLocalPeerAddressDetailsResponse
object
Response schema for local peer address details.
1 property
gatewayErrorResponse
object
Schema for error responses from the API.
5 properties 4 required
gatewayRouterCreateRequest
object
Network gateway router
1 property 1 required
gatewayQueryParamSortServices
string
Sort services by field. Prefix with '-' for descending order.
gatewayIpsecDetailsResponse
object
Response schema for IPsec configuration details.
12 properties
gatewayLabelKey
string
The key of a label.
gatewayLabelDetailsResponse
object
Gateway label
2 properties 2 required
gatewayServiceLogSessionCreateRequest
object
Request to create a new log session for a service.
1 property 1 required
gatewayAddress
object
1 property
gatewayConnectionRouteRequest
object
Network gateway VPN connection route
3 properties 3 required
gatewayPlanDetailsResponse
object
Response schema for gateway plan details.
7 properties
gatewayTunnelListResponse
array
Response schema for a list of gateway tunnels.
gatewayServiceLabelListResponse
array
Response schema for a list of service labels.
gatewayTunnelInternalIpDetailsResponse
object
Response schema for gateway tunnel internal IP details.
2 properties
gatewayServiceModifyRequest
object
Request to modify a gateway service
7 properties
gatewayIpsecMetricsDetailsResponse
object
Response schema for IPsec IKE SA metrics details.
1 property
gatewayTunnelOperationalState
string
Tunnel operational state
gatewayMetricsDetailsResponse
object
Response schema for gateway metrics details.
6 properties
gatewayIpsecIkeSaMetricsDetailsResponse
object
Response schema for IPsec IKE SA metrics details.
18 properties
gatewayServiceLogSessionDetailsResponse
object
Response schema for details of a service log session.
2 properties 2 required
gatewayAddressListResponse
array
Response schema for a list of gateway addresses.
gatewayConnectionRouteType
string
Connection route type
gatewayPlanListResponse
array
Response schema for a list of gateway plans.
gatewaySupportedIntegrityAlgorithms
string
List of supported IPsec integrity algorithms
gatewayLabelCreateRequest
object
Gateway label
2 properties 2 required
gatewayServiceListResponse
array
Response schema for a list of gateway services.
gatewayConnectionListResponse
array
Response schema for a list of gateway connections.
gatewayServiceReplaceRequest
object
Request to replace a gateway service
6 properties 2 required
gatewayConnectionDetailsResponse
object
Response schema for gateway connection details.
8 properties
gatewayRemotePeerAddressDetailsResponse
object
Response schema for remote peer address details.
1 property
gatewayConnectionType
string
Connection type
gatewayTunnelDetailsResponse
object
Response schema for gateway tunnel details.
12 properties
gatewayServiceOperationalState
string
Service operational state
gatewayAddressDetailsResponse
object
Response schema for gateway address details.
3 properties
gatewayServiceDetailsResponse
object
Gateway service
14 properties
gatewayServiceLogSessionCreateResponse
object
Response schema for service log session creation.
1 property 1 required
gatewaySupportedProposalAlgorithms
string
List of supported IPsec proposal algorithms
gatewayServiceMetricsResponse
object
Response schema for service metrics.
2 properties
gatewayConnectionModifyRequest
object
Network gateway VPN connection
6 properties
gatewayConnectionRouteDetailsResponse
object
Response schema for gateway connection route details.
3 properties
gatewayTunnelModifyRequest
object
Request to modify a VPN tunnel
7 properties
gatewayAddressModifyRequest
object
Gateway service address modify request
1 property 1 required
gatewayName
string
The name for the resource.
gatewayAuthenticationDetailsResponse
object
Response schema for authentication details.
1 property
gatewayLabelModifyRequest
object
Gateway label
2 properties
gatewayConnectionCreateRequest
object
Network gateway VPN connection
6 properties 2 required
gatewayTunnelCreateRequest
object
Network gateway VPN connection tunnel
7 properties 4 required
gatewayQueryParamOffset
integer
Schema for a query parameter specifying the offset for pagination.
gatewayServiceConfiguredStatus
string
Service configured status
gatewayLabelValue
stringnull
The value of a label.
gatewayRouterDetailsResponse
object
Response schema for gateway router details.
3 properties
gatewayDiffieHellmanGroupNumber
integer
Diffie-Hellman group number
gatewayIpsecAuthenticationType
string
IPsec authentication type
gatewayServiceCreateRequest
object
Gateway service
10 properties 6 required
gatewayAddressCreateRequest
object
Gateway address
2 properties 1 required
gatewayUuid
string
The unique identifier for the resource.
gatewayQueryParamLimit
integer
Schema for a query parameter specifying the maximum number of entries to return (limit).
gatewayServiceLogSessionTypes
string
Service log session types

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-gateway-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
AE Profile APIs.io
UpCloud Account Tokens API
AE Profile APIs.io
UpCloud Audit Logs API
AE Profile APIs.io
UpCloud Currency API
AE Profile APIs.io
UpCloud Database API
AE Profile APIs.io
UpCloud Device API
AE Profile APIs.io
UpCloud Events API
AE Profile APIs.io
UpCloud File Storage API
AE Profile APIs.io
UpCloud Firewall Ruleset API
AE Profile APIs.io
UpCloud Ip Address API
AE Profile APIs.io
UpCloud Kubernetes API
AE Profile APIs.io
UpCloud Load Balancer API
AE Profile APIs.io
#Gateways
← Back to U APIs
API Details
ID
upcloud:upcloud-gateway-api
Base URL
https://api.upcloud.com
Docs
https://developers.upcloud.com/api/1.3
Provider
UpCloud
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=upcloud-gateway-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/upcloud-gateway-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of UpCloud Gateway API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.