All URIs are relative to https://api-ch-gva-2.exoscale.com/v2
| Method | HTTP request | Description |
|---|---|---|
| add_instance_protection | PUT /instance/{id}:add-protection | Set instance destruction protection |
| create_instance | POST /instance | Create a Compute instance |
| create_snapshot | POST /instance/{id}:create-snapshot | Create a Snapshot of a Compute instance |
| delete_instance | DELETE /instance/{id} | Delete a Compute instance |
| get_console_proxy_url | GET /console/{id} | Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console. |
| get_instance | GET /instance/{id} | Retrieve Compute instance details |
| list_instances | GET /instance | List Compute instances |
| reboot_instance | PUT /instance/{id}:reboot | Reboot a Compute instance |
| remove_instance_protection | PUT /instance/{id}:remove-protection | Remove instance destruction protection |
| reset_instance | PUT /instance/{id}:reset | Reset a Compute instance to a base/target template |
| reset_instance_field | DELETE /instance/{id}/{field} | Reset Instance field |
| reset_instance_password | PUT /instance/{id}:reset-password | Reset a compute instance password |
| resize_instance_disk | PUT /instance/{id}:resize-disk | Resize a Compute instance disk |
| reveal_instance_password | GET /instance/{id}:password | Reveal the password used during instance creation or the latest password reset. |
| revert_instance_to_snapshot | POST /instance/{instance-id}:revert-snapshot | Revert a snapshot for an instance |
| scale_instance | PUT /instance/{id}:scale | Scale a Compute instance to a new Instance Type |
| start_instance | PUT /instance/{id}:start | Start a Compute instance |
| stop_instance | PUT /instance/{id}:stop | Stop a Compute instance |
| update_instance | PUT /instance/{id} | Update a Compute instance |
models::Operation add_instance_protection(id) Set instance destruction protection
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation create_instance(create_instance_request) Create a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_instance_request | CreateInstanceRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation create_snapshot(id) Create a Snapshot of a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation delete_instance(id) Delete a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetConsoleProxyUrl200Response get_console_proxy_url(id) Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
models::GetConsoleProxyUrl200Response
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Instance get_instance(id) Retrieve Compute instance details
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ListInstances200Response list_instances(manager_id, manager_type, ip_address) List Compute instances
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| manager_id | Option<uuid::Uuid> | |||
| manager_type | Option<String> | |||
| ip_address | Option<String> |
models::ListInstances200Response
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation reboot_instance(id) Reboot a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation remove_instance_protection(id) Remove instance destruction protection
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation reset_instance(id, reset_instance_request) Reset a Compute instance to a base/target template
This operation re-installs a Compute instance to a base template. If target template is provided it will be used to recreated instance from. Warning: the operation wipes all data stored on the disk.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| reset_instance_request | ResetInstanceRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation reset_instance_field(id, field) Reset Instance field
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| field | String | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation reset_instance_password(id) Reset a compute instance password
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation resize_instance_disk(id, resize_instance_disk_request) Resize a Compute instance disk
This operation resizes a Compute instance's disk volume. Note: the disk can only grow, cannot be shrunk.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| resize_instance_disk_request | ResizeInstanceDiskRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::InstancePassword reveal_instance_password(id) Reveal the password used during instance creation or the latest password reset.
Reveal the password used during instance creation or the latest password reset. This is only available for VMs created against templates having the password-enabled property set to true. Passwords are transiently stored for at most 24 hours and intended to be retrieved shortly after creation or resets.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation revert_instance_to_snapshot(instance_id, revert_instance_to_snapshot_request) Revert a snapshot for an instance
This operation reverts the snapshot to the Compute instance volume, restoring stored data as it was at the time of the snapshot. The Compute instance must be previously stopped.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_id | uuid::Uuid | [required] | ||
| revert_instance_to_snapshot_request | RevertInstanceToSnapshotRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation scale_instance(id, scale_instance_request) Scale a Compute instance to a new Instance Type
This operation changes the Compute instance's type. Note: the new Instance Type must be within the same family (e.g. a standard instance cannot be scaled to gpu2 or storage).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| scale_instance_request | ScaleInstanceRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation start_instance(id, start_instance_request) Start a Compute instance
This operation starts a virtual machine, potentially using a rescue profile if specified
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| start_instance_request | StartInstanceRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation stop_instance(id) Stop a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Operation update_instance(id, update_instance_request) Update a Compute instance
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | uuid::Uuid | [required] | ||
| update_instance_request | UpdateInstanceRequest | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]