Reference
Exoscale API
Block Storage

Block Storage

Exoscale’s Block Storage offers persistent externally attached volumes for your Compute instances.

Read more

create-block-storage-snapshot

Create a block storage snapshot

POST /block-storage/{id}:create-snapshot

Path parameters

  • id in path (required)

Request body

  • application/json
    • name (string): Snapshot name
    • labels (object)

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 create-block-storage-snapshot: golang | Python | Java

CLI: exo api create-block-storage-snapshot

get-block-storage-snapshot

Retrieve block storage snapshot details

GET /block-storage-snapshot/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Snapshot ID
      • name (string): Snapshot name
      • size (integer): Snapshot size
      • volume-size (integer): Original Volume size
      • created-at (string): Snapshot creation date
      • state (string): Snapshot state
      • labels (object)
      • block-storage-volume (object): Target block storage volume - schema details

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

CLI: exo api get-block-storage-snapshot

update-block-storage-snapshot

Update block storage volume snapshot

PUT /block-storage-snapshot/{id}

Path parameters

  • id in path (required)

Request body

  • application/json
    • name (string): Snapshot name
    • labels (object)

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 update-block-storage-snapshot: golang | Python | Java

CLI: exo api update-block-storage-snapshot

delete-block-storage-snapshot

Delete a block storage snapshot, data will be unrecoverable

DELETE /block-storage-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-block-storage-snapshot: golang | Python | Java

CLI: exo api delete-block-storage-snapshot

create-block-storage-volume

Create a block storage volume

POST /block-storage

Request body

  • application/json
    • name (string): Volume name
    • size (integer): Volume size in GiB. When a snapshot ID is supplied, this defaults to the size of the source volume, but can be set to a larger value.
    • labels (object)
    • block-storage-snapshot (object): Target block storage snapshot - schema details

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 create-block-storage-volume: golang | Python | Java

CLI: exo api create-block-storage-volume

get-block-storage-volume

Retrieve block storage volume details

GET /block-storage/{id}

Path parameters

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • labels (object)
      • instance (object): Target Instance - schema details
      • name (string): Volume name
      • state (string): Volume state
      • size (integer): Volume size
      • blocksize (integer): Volume block size
      • block-storage-snapshots (array[object]): Volume snapshots, if any - schema details
      • id (string): Volume ID
      • created-at (string): Volume creation date

SDK reference for get-block-storage-volume: golang | Python | Java

CLI: exo api get-block-storage-volume

resize-block-storage-volume

Resize a block storage volume

PUT /block-storage/{id}:resize-volume

This operation resizes a Block storage volume. Note: the volume can only grow, cannot be shrunk. Only detached volumes or volumes attached to stopped instances can be resized.

Path parameters

  • id in path (required)

Request body

  • application/json
    • size (required) (integer): Volume size in GiB

Responses

  • 200: 200
    • application/json
      • labels (object)
      • instance (object): Target Instance - schema details
      • name (string): Volume name
      • state (string): Volume state
      • size (integer): Volume size
      • blocksize (integer): Volume block size
      • block-storage-snapshots (array[object]): Volume snapshots, if any - schema details
      • id (string): Volume ID
      • created-at (string): Volume creation date

SDK reference for resize-block-storage-volume: golang | Python | Java

CLI: exo api resize-block-storage-volume

detach-block-storage-volume

Detach block storage volume

PUT /block-storage/{id}:detach

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 detach-block-storage-volume: golang | Python | Java

CLI: exo api detach-block-storage-volume

update-block-storage-volume

Update block storage volume

PUT /block-storage/{id}

Path parameters

  • id in path (required)

Request body

  • application/json
    • name (string): Volume name
    • labels (object)

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 update-block-storage-volume: golang | Python | Java

CLI: exo api update-block-storage-volume

delete-block-storage-volume

Delete a block storage volume, data will be unrecoverable

DELETE /block-storage/{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-block-storage-volume: golang | Python | Java

CLI: exo api delete-block-storage-volume

Other Operations

list-block-storage-snapshots

List block storage snapshots

GET /block-storage-snapshot

Responses

  • 200: 200
    • application/json

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

CLI: exo api list-block-storage-snapshots

attach-block-storage-volume-to-instance

Attach block storage volume to an instance

PUT /block-storage/{id}:attach

Path parameters

  • id in path (required)

Request body

  • application/json

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 attach-block-storage-volume-to-instance: golang | Python | Java

CLI: exo api attach-block-storage-volume-to-instance

list-block-storage-volumes

List block storage volumes

GET /block-storage

Query parameters

  • instance-id in query (optional)

Responses

  • 200: 200
    • application/json

SDK reference for list-block-storage-volumes: golang | Python | Java

CLI: exo api list-block-storage-volumes

Last updated on