Volume Attachment

Update a volume attachment

Updates an existing volume attachment by modifying its attributes such as the protected status, which prevents detachment of critical system volumes. This is useful for enforcing safeguards on production-critical storage devices. Retrieve the volume_attachment_id by calling the List volumes endpoint and inspecting the attachments field of each volume object.

patch/core/volume-attachments/{volume_attachment_id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/volume-attachments/{volume_attachment_id}
  • Auth: API key in header api_key

Path parameters

volume_attachment_idinteger required

ID of the volume attachment.

Request body

protectedboolean

When set to true, the volume attachment is marked as protected, preventing accidental or manual detachment from the VM.

Response

Volume attachment has been updated

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "message": "We can process with only available volumes.",
  "volume_attachments": [
    {
      "id": 9876,
      "instance_id": 1129,
      "volume_id": 1402,
      "device": "/dev/disk/by-id/virtio-a66fd1a8-e198-4eb4-a",
      "status": "ATTACHING",
      "created_at": "2026-05-07T09:21:55Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.