# UpCloud Server API

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

UpCloud Server 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 Servers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Manages Cloud Servers

## Operations (41)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.3/server` | List Cloud Servers |
| POST | `/1.3/server` | Create a new Cloud Server |
| GET | `/1.3/server/firewall_ruleset_relationships/private/{ruleset_uuid}` | List Cloud Servers related to a private firewall ruleset |
| GET | `/1.3/server/labels` | List Cloud Server labels |
| GET | `/1.3/server/{uuid}` | Get Cloud Server details |
| PUT | `/1.3/server/{uuid}` | Modify an existing Cloud Server |
| DELETE | `/1.3/server/{uuid}` | Delete a Cloud Server |
| POST | `/1.3/server/{uuid}/attach_firewall_ruleset/private` | Attach a private firewall ruleset |
| POST | `/1.3/server/{uuid}/cancel` | Cancel a Cloud Server operation |
| POST | `/1.3/server/{uuid}/cdrom/eject` | Eject the CD-ROM image from a Cloud Server |
| POST | `/1.3/server/{uuid}/cdrom/load` | Load a CD-ROM image into a Cloud Server |
| POST | `/1.3/server/{uuid}/detach_firewall_ruleset/private` | Detach a private firewall ruleset |
| GET | `/1.3/server/{uuid}/firewall_rule` | List firewall rules |
| PUT | `/1.3/server/{uuid}/firewall_rule` | Replace firewall rules |
| POST | `/1.3/server/{uuid}/firewall_rule` | Create a firewall rule |
| GET | `/1.3/server/{uuid}/firewall_rule/{position}` | Get a firewall rule |
| DELETE | `/1.3/server/{uuid}/firewall_rule/{position}` | Delete a firewall rule |
| GET | `/1.3/server/{uuid}/firewall_ruleset_relationships/private` | List private firewall ruleset relationships for a Cloud Server |
| GET | `/1.3/server/{uuid}/gpus` | List Cloud Server GPUs |
| GET | `/1.3/server/{uuid}/networking` | Get Cloud Server networking details |
| POST | `/1.3/server/{uuid}/networking/interface` | Add a network interface |
| PUT | `/1.3/server/{uuid}/networking/interface/{index}` | Modify a network interface |
| DELETE | `/1.3/server/{uuid}/networking/interface/{index}` | Delete a network interface |
| POST | `/1.3/server/{uuid}/networking/interface/{index}/ip_address` | Add an IP address to a network interface |
| DELETE | `/1.3/server/{uuid}/networking/interface/{index}/ip_address/{ip}` | Delete an IP address from a network interface |
| POST | `/1.3/server/{uuid}/rebuild` | Rebuild a Cloud Server |
| POST | `/1.3/server/{uuid}/relocate` | Relocate a Cloud Server to another zone |
| GET | `/1.3/server/{uuid}/remote_access_details` | Get remote access connection details |
| POST | `/1.3/server/{uuid}/restart` | Restart a Cloud Server |
| POST | `/1.3/server/{uuid}/start` | Start a Cloud Server |
| GET | `/1.3/server/{uuid}/stats/cpu` | Get Cloud Server CPU statistics |
| GET | `/1.3/server/{uuid}/stats/cpu/{period}` | Get Cloud Server CPU statistics by period |
| GET | `/1.3/server/{uuid}/stats/disk/{type}` | Get Cloud Server disk statistics |
| GET | `/1.3/server/{uuid}/stats/disk/{type}/{period}` | Get Cloud Server disk statistics by period |
| GET | `/1.3/server/{uuid}/stats/network/{type}` | Get Cloud Server network statistics |
| GET | `/1.3/server/{uuid}/stats/network/{type}/{network}` | Get Cloud Server network statistics by network type |
| GET | `/1.3/server/{uuid}/stats/network/{type}/{network}/{period}` | Get Cloud Server network statistics by network type and period |
| POST | `/1.3/server/{uuid}/stop` | Stop a Cloud Server |
| POST | `/1.3/server/{uuid}/storage/attach` | Attach a storage device to a Cloud Server |
| POST | `/1.3/server/{uuid}/storage/detach` | Detach a storage device from a Cloud Server |
| GET | `/1.3/server/{uuid}/vnc_details` | Get VNC connection details |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/upcloud/openapi/upcloud-server-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 Gateway API](https://apis.io/apis/upcloud/upcloud-gateway-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/)

## Tags

Servers

---

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