.. role:: green

List All Volumes
================

**Type:** :guilabel:`GET`

.. py:function:: https://cloud.syminet.com/api/v1/volumes

    Return a paginated list of all volumes.

**Optional URL Parameters:**

?query=VOLUME_NAME
  Filter on VOLUME_NAME (partial match okay)

?page=PAGE_NUMBER
  Return page PAGE_NUMBER

.. code-block:: shell
   :caption: Curl

    curl --request GET \
         --url https://cloud.syminet.com/api/v1/volumes \
         --header "authorization:bearer $API_TOKEN"

.. code-block:: json
    :caption: Response

    {
      "data" : [
        {
          "created" : "Wed, 20 Nov 2024 22:01:30 GMT",
          "datacenter_id" : 6,
          "id" : 160,
          "legacy" : null,
          "perms" : "rw",
          "region" : "SFO1",
          "status" : "active",
          "vm_datacenter_id" : 6,
          "vm_deleted" : null,
          "vm_id" : 3247,
          "vm_perms" : "rw",
          "vmname" : "11test1-3247.com",
          "volname" : "myvolume",
          "volsize" : 100
       }
     ],
     "page" : 1,
     "pages" : 2,
     "results" : 1
    }