Reference
Exoscale API
Compute
Snapshot

Snapshot

Snapshots provide a way to get point-in-time recovery for your Compute instance.

Read more

get-snapshot

Retrieve Snapshot details

GET /snapshot/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Snapshot ID
      • name (string): Snapshot name
      • created-at (string): Snapshot creation date
      • state (string): Snapshot state
      • size (integer): Snapshot size in GiB
      • export (object): Exported snapshot information - schema details
      • instance (object): Instance - schema details
      • application-consistent (boolean): Indicates whether the snapshot was taken using an application-consistent method

SDK reference for get-snapshot: golang | Python | Java

CLI: exo api get-snapshot

delete-snapshot

Delete a Snapshot

DELETE /snapshot/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for delete-snapshot: golang | Python | Java

CLI: exo api delete-snapshot

Other Operations

export-snapshot

Export a Snapshot

POST /snapshot/{id}:export

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for export-snapshot: golang | Python | Java

CLI: exo api export-snapshot

promote-snapshot-to-template

Promote a Snapshot to a Template

POST /snapshot/{id}:promote

Path parameters

  • id in path (required)

Request body

  • application/json
    • name (required) (string): Template name
    • description (string): Template description
    • default-user (string): Template default user
    • ssh-key-enabled (boolean): Enable SSH key-based login in the template
    • password-enabled (boolean): Enable password-based login in the template

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for promote-snapshot-to-template: golang | Python | Java

CLI: exo api promote-snapshot-to-template

list-snapshots

List Snapshots

GET /snapshot

Responses

SDK reference for list-snapshots: golang | Python | Java

CLI: exo api list-snapshots

Last updated on