---
title: "Compute"
description: "Virtual machine instances in your projects, with block storage volumes, public IPv4 addresses and firewalls."
---

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

# Compute

EZGH Compute runs virtual machine instances in a project. In the console, open **Compute**. Its
sidebar groups everything an instance uses:

| Group | Pages | What they hold |
| --- | --- | --- |
| Instances | [Instances](/compute/instances), [SSH keys](/compute/ssh-keys) | Virtual machines, and the public keys you log in with |
| Images | [Images](/compute/images) | The operating system images instances launch from |
| Storage | [Volumes](/compute/volumes), [Snapshots](/compute/snapshots) | Encrypted block storage, and point-in-time copies of it |
| Network & security | [IPv4 addresses](/compute/ipv4-addresses), [Firewalls](/compute/firewalls) | Optional public IPv4 addresses, and stateful allow rules |

VPCs, subnets and network interfaces are in [Private Networks](/private-networks): in the console,
open **Private Networks**.

Every resource belongs to one project in the `us-west-1` region, and can only be used with
resources in the same project.

- [Get started](/compute/get-started) — Launch your first instance and connect to it with SSH.
- [Instances](/compute/instances) — Launch, stop, start, reboot, resize and terminate instances.
- [User data and instance metadata](/compute/user-data-and-metadata) — Configure an instance at boot with cloud-init, and read its details from inside it.
- [Consoles and console output](/compute/consoles) — Reach an instance's serial or VNC console, and read its boot output, without the network.
- [Monitoring](/compute/monitoring) — Per-instance CPU and per-volume metrics in Observability, free.
- [IAM](/compute/iam) — The actions and managed policies for instances, volumes, networking and firewalls.

## Resource IDs

Each resource has an ID with a prefix that names its type, the `slug` in API responses (`id` is
its UUID). API paths accept either; request bodies take the prefixed ID only.

| Resource | ID | API |
| --- | --- | --- |
| Instance | `ins_…` | [Compute](/compute-api/ListInstances/) |
| SSH key | `ssh_…` | [Compute](/compute-api/ListSshKeys/) |
| Volume | `vol_…` | [Block Storage](/blockstore-api/ListVolumes/) |
| Snapshot | `snp_…` | [Block Storage](/blockstore-api/ListSnapshots/) |
| Network interface | `eni_…` | [Network](/network-api/ListNetworkInterfaces/) |
| IPv4 address | `pip_…` | [Network](/network-api/ListIpv4Addresses/) |
| VPC | `vpc_…` | [Network](/network-api/ListVpcs/) |
| Subnet | `sbn_…` | [Network](/network-api/ListSubnets/) |
| Firewall | `fwl_…` | [Firewall](/firewall-api/ListFirewalls/) |

## APIs

| API | Host |
| --- | --- |
| Compute: instances, instance types, SSH keys | `compute-api.ezghcloud.com` |
| Block Storage: volumes, volume types, snapshots | `blockstore-api.ezghcloud.com` |
| Network: network interfaces, IPv4 addresses, VPCs and subnets | `network-api.ezghcloud.com` |
| Firewall: firewalls, rules, attachments | `firewall-api.ezghcloud.com` |

Every path is under `/v1/organizations/{orgId}`, and most under
`/v1/organizations/{orgId}/projects/{projectId}`, with the organization's and project's UUIDs.
Authentication, paging and errors follow the [API conventions](/api).

## Operations

Launching, starting, stopping, rebooting, resizing and terminating an instance, attaching and
detaching a running instance's volumes, and creating, modifying and deleting volumes and snapshots,
take time. Those requests answer `202` with an
**operation** and a `Location` header naming it. Poll the operation until its `status` is
`succeeded`, `failed` or `cancelled`; while it's `queued` or `running`, `Retry-After` says when to
poll again. A failed operation's `error` has a `code` and a `message`.

```sh
curl -sS "https://compute-api.ezghcloud.com/v1/organizations/$ORG_ID/operations/$OPERATION_ID" \
  -H "Authorization: Bearer $EZGH_API_KEY"
```

From the CLI, `ezgh compute operations list|get|cancel` covers compute's operations and
`ezgh compute volumes operations list|get|cancel` Block Storage's, and the commands that start an
operation take `--wait`.

Compute's operations are at [GetOperation](/compute-api/GetOperation/) on
`compute-api.ezghcloud.com`, Block Storage's at [GetOperation](/blockstore-api/GetOperation/)
on `blockstore-api.ezghcloud.com`. Both list the organization's operations, newest first, and
cancel one that's still `cancellable`. Assigning, unassigning and moving a secondary private address
are Network's own [private address operations](/private-networks/vpcs#operations). Every other change is synchronous.

Send an `Idempotency-Key` header with every `POST` so that a retry gets the first request's answer
instead of acting twice.

Source: https://docs.ezghcloud.com/compute/index.mdx
