GET /compute/instances/{instance_id}
Read a machine
Read a virtual machine: state, SSH access, host keys. Use when after create or a power action, until the state is stable. Before: a vm_ id. Returns the machine, its ssh command and the host key fingerprints to check on first login; balance_stopped_at and delete_scheduled_at when the machine is stopped for lack of balance. Scope: compute:read.
API key (Bearer), on the public API endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
instance_id | path | string · required | Machine id (vm_...). |
Responses
| Status | Description | Body |
|---|---|---|
2XX | Success: the JSON body the route returns (see the description for its fields). | object |
401 | Key missing or invalid | Error |
4XX | Refused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account). | Error |
Examples
curl
curl -X GET "$GALON_API_BASE/compute/instances/<instance_id>" \
-H "Authorization: Bearer $GALON_API_KEY"DELETE /compute/instances/{instance_id}
Delete a machine
Delete a virtual machine and its disk. Cannot be undone. Use when the user explicitly asked to delete this machine and its data. Before: get_compute_instance (needs compute read access), to read its exact name. Returns the machine in state deleting. Scope: compute:delete.
API key (Bearer), on the public API endpoint.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
instance_id | path | string · required | Machine id (vm_...). |
confirm | query | string · required | The exact machine name, as confirmation. |
Responses
| Status | Description | Body |
|---|---|---|
2XX | Success: the JSON body the route returns (see the description for its fields). | object |
401 | Key missing or invalid | Error |
4XX | Refused: act on detail.code, then follow detail.next_action (404 not_found while the service is not open to the account). | Error |
Examples
curl
curl -X DELETE "$GALON_API_BASE/compute/instances/<instance_id>" \
-H "Authorization: Bearer $GALON_API_KEY"