Back to top

Volume Attachments

Volume Attachment Management (Block Storage)

Retrieve all volume attachment
GET
/storage/{id}/attachments

Returns a list of the current volume’s attachments.

  • Parameters
  • id
    string  (required) in path

    Volume UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"attachments": [
    		{
    			"id": "string",
    			"created_at": "string",
    			"volume": {
    				"href": "string"
    			},
    			"device": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Attach your volume
/storage/{id}/attachments

Attach your volume to a device.

  • Parameters
  • id
    string  (required) in path

    Volume UUID

    attachment
     (required) in body

    Device to attach

    {
    	"device_id": "string"
    }
  • Response  201   created
  • {
    	"id": "string",
    	"created_at": "string",
    	"volume": {
    		"href": "string"
    	},
    	"device": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve an attachment
GET
/storage/attachments/{id}

Returns a single attachment if the user has access

  • Parameters
  • id
    string  (required) in path

    Attachment UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"created_at": "string",
    	"volume": {
    		"href": "string"
    	},
    	"device": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Detach volume
/storage/attachments/{id}

Detach volume.

  • Parameters
  • id
    string  (required) in path

    Attachment UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found