> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# UpCloud Reference

> Configuration options, datacenter zones, server plans, and API endpoints for Ankra-managed UpCloud clusters.

Reference material for [UpCloud clusters](/guides/upcloud-clusters).

***

## Cluster Configuration Options

| Parameter               | Default         | Description                                                                               |
| ----------------------- | --------------- | ----------------------------------------------------------------------------------------- |
| `name`                  | *required*      | Unique cluster name                                                                       |
| `credential_id`         | *required*      | UpCloud API credential ID                                                                 |
| `ssh_key_credential_id` | *required*      | SSH key credential ID                                                                     |
| `zone`                  | *required*      | UpCloud datacenter zone                                                                   |
| `network_ip_range`      | `10.0.0.0/24`   | Private network IP range                                                                  |
| `bastion_plan`          | `1xCPU-1GB`     | Server plan for the bastion host                                                          |
| `control_plane_count`   | `1`             | Number of control plane nodes (1 or 3)                                                    |
| `control_plane_plan`    | `2xCPU-4GB`     | Server plan for control planes                                                            |
| `worker_count`          | `1`             | Number of worker nodes (legacy, use `node_groups` instead)                                |
| `worker_plan`           | `2xCPU-4GB`     | Server plan for workers (legacy, use `node_groups` instead)                               |
| `node_groups`           |                 | Array of node group definitions (see [Node Groups](/guides/upcloud-clusters#node-groups)) |
| `distribution`          | `k3s`           | Kubernetes distribution                                                                   |
| `kubernetes_version`    | *latest stable* | Kubernetes version (optional)                                                             |

### UpCloud Datacenter Zones

| Zone      | Location               |
| --------- | ---------------------- |
| `fi-hel1` | Helsinki, Finland      |
| `de-fra1` | Frankfurt, Germany     |
| `us-chi1` | Chicago, United States |
| `nl-ams1` | Amsterdam, Netherlands |
| `uk-lon1` | London, United Kingdom |
| `sg-sin1` | Singapore              |
| `au-syd1` | Sydney, Australia      |
| `pl-waw1` | Warsaw, Poland         |

### UpCloud Server Plans

| Plan         | vCPUs | RAM   | Monthly Cost |
| ------------ | ----- | ----- | ------------ |
| `1xCPU-1GB`  | 1     | 1 GB  | \$5.00       |
| `2xCPU-4GB`  | 2     | 4 GB  | \$20.00      |
| `4xCPU-8GB`  | 4     | 8 GB  | \$40.00      |
| `8xCPU-16GB` | 8     | 16 GB | \$80.00      |

<Note>
  Available plans may vary by zone. Check the [UpCloud pricing page](https://upcloud.com/pricing/) for the latest offerings.
</Note>

***

## Node Group API Reference

| Endpoint                                                         | Method | Description                |
| ---------------------------------------------------------------- | ------ | -------------------------- |
| `/api/v1/clusters/upcloud/{id}/node-groups`                      | GET    | List all node groups       |
| `/api/v1/clusters/upcloud/{id}/node-groups`                      | POST   | Add a node group           |
| `/api/v1/clusters/upcloud/{id}/node-groups/{name}/scale`         | PUT    | Scale a node group (0–100) |
| `/api/v1/clusters/upcloud/{id}/node-groups/{name}/instance-type` | PUT    | Change server plan         |
| `/api/v1/clusters/upcloud/{id}/node-groups/{name}/labels`        | PUT    | Update labels              |
| `/api/v1/clusters/upcloud/{id}/node-groups/{name}/taints`        | PUT    | Update taints              |
| `/api/v1/clusters/upcloud/{id}/node-groups/{name}`               | DELETE | Delete a node group        |