List Instance Volumes

Fetch a list of volumes associated with the specified instance.

Requires the containers-view permission.

query
  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns a list of instance volumes, otherwise returns an Error.

Instance Volume Resource
  • config
    object

    An object describing a volume's configuration.

    Show child fields
  • deployed
    object

    Information about the deployed volume.

    Show child fields
  • sftp
    object | null

    If remote access is enabled, the information required to connect.

    Show child fields

GET /v1/containers/{CONTAINER_ID}/instances/{INSTANCE_ID}/volumes

Example Request
$ curl https://api.cycle.io/v1/containers/5b9c2a77b6393d0001eb45fd/instances/5cc78aa0db2ab000014a8b98/volumes \
  -H 
"Authorization: Bearer  API_KEY"
 \
  -H 
"X-HUB-ID:  HUB_ID"
Example Response
{
  "data": [
    {
      "id": "5cec6047414638000193475c",
      "config": {
        "local": {
          "max_size": "1G"
        },
        "destination": "/var/lib/registry",
        "read_only": false,
        "remote_access": {
          "enable": true,
          "web_hook": "",
          "password": {
            "algorithm": "raw",
            "data": "testpassword"
          }
        }
      },
      "deployed": {
        "server_id": "5a14de0a78ecdb000128b9ec",
        "container_id": "5cec6047414638000193475b",
        "container_volume_id": "5cec6047414638000193475c",
        "instance_id": "5cec608cdb2ab00001777d28",
        "hash": "47d50f",
        "path": "/var/lib/registry",
        "storage": {
          "used": 366,
          "total": 925
        },
        "last_updated": "2019-06-17T04:14:03.694Z"
      },
      "sftp": {
        "host": "qsbyw-equinix-sjc1.s.5a14ddd8b6393d0001976f44.cycle.io",
        "port": 2022,
        "username": "5cec608cdb2ab00001777d28.5cec6047414638000193475c",
        "password": {
          "algorithm": "raw",
          "data": "testpassword"
        }
      }
    }
  ]
}