# UpCloud Gateway API

**Canonical:** https://apis.io/apis/upcloud/upcloud-gateway-api/  
**Provider:** UpCloud — https://apis.io/providers/upcloud/  
**Base URL:** https://api.upcloud.com  
**Documentation:** https://developers.upcloud.com/api/1.3

UpCloud Gateway API is one of 29 APIs that [UpCloud](https://apis.io/providers/upcloud/) publishes on the [APIs.io](https://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.

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

## Operations (30)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.3/gateway/plans` | List Plans |
| GET | `/1.3/gateway/plans/{plan-name}` | Get Plan Details |
| GET | `/1.3/gateway` | List Services |
| POST | `/1.3/gateway` | Create Service |
| GET | `/1.3/gateway/{service-uuid}` | Get Service Details |
| PUT | `/1.3/gateway/{service-uuid}` | Replace Service |
| DELETE | `/1.3/gateway/{service-uuid}` | Delete Service |
| PATCH | `/1.3/gateway/{service-uuid}` | Modify Service |
| PATCH | `/1.3/gateway/{service-uuid}/actions/nat-flush-connections` | Flush NAT |
| GET | `/1.3/gateway/{service-uuid}/connections` | List Connections |
| POST | `/1.3/gateway/{service-uuid}/connections` | Create Connection |
| GET | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}` | Get Connection Details |
| DELETE | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}` | Delete Connection |
| PATCH | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}` | Modify Connection |
| GET | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels` | List Tunnels |
| POST | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels` | Create Tunnel |
| GET | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}` | Get Tunnel Details |
| DELETE | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}` | Delete Tunnel |
| PATCH | `/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}` | Modify Tunnel |
| GET | `/1.3/gateway/{service-uuid}/labels` | List Service Labels |
| POST | `/1.3/gateway/{service-uuid}/labels` | Create Service Label |
| GET | `/1.3/gateway/{service-uuid}/labels/{label-key}` | Get Service Label Details |
| DELETE | `/1.3/gateway/{service-uuid}/labels/{label-key}` | Delete Service Label |
| PATCH | `/1.3/gateway/{service-uuid}/labels/{label-key}` | Modify Service Label |
| GET | `/1.3/gateway/{service-uuid}/addresses` | List Service Addresses |
| GET | `/1.3/gateway/{service-uuid}/addresses/{address-name}` | Get Service Address Details |
| PATCH | `/1.3/gateway/{service-uuid}/addresses/{address-name}` | Modify Service Address |
| POST | `/1.3/gateway/{service-uuid}/addresses/{address-name}/release` | Release Gateway Floating IP |
| GET | `/1.3/gateway/{service-uuid}/metrics` | Get Service Metrics |
| POST | `/1.3/gateway/{service-uuid}/logs` | Create Service Log Session |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/upcloud/openapi/upcloud-gateway-api-openapi.yml
- **Documentation** — https://developers.upcloud.com/api/1.3

## Other UpCloud APIs (12)

- [UpCloud Account API](https://apis.io/apis/upcloud/upcloud-account-api/)
- [UpCloud Account Tokens API](https://apis.io/apis/upcloud/upcloud-account-tokens-api/)
- [UpCloud Audit Logs API](https://apis.io/apis/upcloud/upcloud-audit-logs-api/)
- [UpCloud Currency API](https://apis.io/apis/upcloud/upcloud-currency-api/)
- [UpCloud Database API](https://apis.io/apis/upcloud/upcloud-database-api/)
- [UpCloud Device API](https://apis.io/apis/upcloud/upcloud-device-api/)
- [UpCloud Events API](https://apis.io/apis/upcloud/upcloud-events-api/)
- [UpCloud File Storage API](https://apis.io/apis/upcloud/upcloud-file-storage-api/)
- [UpCloud Firewall Ruleset API](https://apis.io/apis/upcloud/upcloud-firewall-ruleset-api/)
- [UpCloud Ip Address API](https://apis.io/apis/upcloud/upcloud-ip-address-api/)
- [UpCloud Kubernetes API](https://apis.io/apis/upcloud/upcloud-kubernetes-api/)
- [UpCloud Load Balancer API](https://apis.io/apis/upcloud/upcloud-load-balancer-api/)

## Tags

Gateways

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/upcloud/upcloud-gateway-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/upcloud/.