window.API = {
  "sections": [
    {
      "name": "Consistency Groups",
      "description": "Operations involving Consistency Groups.",
      "methods": [
        {
          "uri": "/consistency_groups/suspend_cgs_for_snapshot_set",
          "method": "POST",
          "description": "Suspend consistency groups for a snapshot set.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            },
            {
              "name": "cg",
              "type": "string",
              "required": true,
              "description": "The consistency group name",
              "example": "cg name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<suspend-cgs-for-snapshot-set-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</suspend-cgs-for-snapshot-set-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/create_snapshot_set_and_resume",
          "method": "POST",
          "description": "Create a snapshot set and resumes.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-snapshot-set-and-resume-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</create-snapshot-set-and-resume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/clone_snapshot_set",
          "method": "POST",
          "description": "Clone a snapshot set.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<clone_snapshot_set-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</clone_snapshot_set-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/delete_clone_of_snapshot_set",
          "method": "POST",
          "description": "Delete a clone of a snapshot set.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<delete-clone-of-snapshot-set-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</delete-clone-of-snapshot-set-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/delete_snapshot_set",
          "method": "POST",
          "description": "Delete a snapshot set.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<delete-snapshot-set-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</delete-snapshot-set-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/cancel_suspend_for_snapshot_set",
          "method": "POST",
          "description": "Cancel suspend for a snapshot set.",
          "parameters": [
            {
              "name": "snapsetid",
              "type": "string",
              "required": true,
              "description": "The snapshot set id",
              "example": "snapshot set id"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<cancel-suspend-for-snapshot-set-response>\n  <snapshot-set-name>snapshot set id</snapshot-set-name>\n  <status type=\"integer\">0</status>\n</cancel-suspend-for-snapshot-set-response>",
          "response_json": "{\n  \"response\": {\n    \"snapshot_set_name\": \"snapshot set id\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Drives",
      "description": "Operations involving Drives.",
      "methods": [
        {
          "uri": "/drives",
          "method": "GET",
          "description": "Returns a list of all drives.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-disks-response>\n    <status type=\"integer\">0</status>\n    <disks-count type=\"integer\">4</disks-count>\n    <disks type=\"array\">\n        <disk>\n            <name>volume-00002575</name>\n            <display-name>drive-000</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>50014EE057E2B026</disk-uuid>\n            <storage-node>ubuntu-sata-51</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <allocation-zone></allocation-zone>\n            <allocation-zone-display-name></allocation-zone-display-name>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n        <disk>\n            <name>volume-00002576</name>\n            <display-name>drive-001</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6000000000BC614E187D90340A867A8F</disk-uuid>\n            <storage-node>ubuntu-sata-31</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <allocation-zone></allocation-zone>\n            <allocation-zone-display-name></allocation-zone-display-name>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n    </disks>\n</show-disks-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"disks\": [\n      {\n        \"name\": \"volume-00002575\",\n        \"display_name\": \"drive-000\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"50014EE057E2B026\",\n        \"storage_node\": \"ubuntu-sata-51\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"allocation_zone\": null,\n        \"allocation_zone_display_name\": null,\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"volume-00002576\",\n        \"display_name\": \"drive-001\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6000000000BC614E187D90340A867A8F\",\n        \"storage_node\": \"ubuntu-sata-31\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"allocation_zone\": null,\n        \"allocation_zone_display_name\": null,\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      }\n    ],\n    \"count\": 4\n  }\n}"
        },
        {
          "uri": "/drives/{id}",
          "method": "GET",
          "description": "Returns the details for a single drive.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-disk-response>\n    <status type=\"integer\">0</status>\n    <disk>\n        <name>volume-00002575</name>\n        <display-name>drive-000</display-name>\n        <disk-type>SATA_465GB_7200RPM</disk-type>\n        <disk-uuid>50014EE057E2B026</disk-uuid>\n        <storage-node>ubuntu-sata-51</storage-node>\n        <vpartition-id type=\"integer\">0</vpartition-id>\n        <raid-group-name/>\n        <usage>Available</usage>\n        <status>Available</status>\n        <capacity type=\"integer\">465</capacity>\n        <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n        <cache>NO</cache>\n        <allocation-zone></allocation-zone>\n        <allocation-zone-display-name></allocation-zone-display-name>\n        <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n        <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n    </disk>\n</show-one-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"disk\": {\n      \"name\": \"volume-00002575\",\n      \"display_name\": \"drive-000\",\n      \"disk_type\": \"SATA_465GB_7200RPM\",\n      \"disk_uuid\": \"50014EE057E2B026\",\n      \"storage_node\": \"ubuntu-sata-51\",\n      \"vpartition_id\": 0,\n      \"raid_group_name\": null,\n      \"usage\": \"Available\",\n      \"status\": \"Available\",\n      \"capacity\": 465,\n      \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n      \"cache\": \"NO\",\n      \"allocation_zone\": null,\n      \"allocation_zone_display_name\": null,\n      \"created_at\": \"2013-09-25 09:22:25 UTC\",\n      \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/drives/free",
          "method": "GET",
          "description": "Returns a list of free drives which are not part of any Raid Group.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-disks-free-response>\n    <status type=\"integer\">0</status>\n    <disks-count type=\"integer\">4</disks-count>\n    <disks type=\"array\">\n        <disk>\n            <name>volume-00002575</name>\n            <display-name>drive-000</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>50014EE057E2B026</disk-uuid>\n            <storage-node>ubuntu-sata-51</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n        <disk>\n            <name>volume-00002576</name>\n            <display-name>drive-001</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6000000000BC614E187D90340A867A8F</disk-uuid>\n            <storage-node>ubuntu-sata-31</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n        <disk>\n            <name>volume-00002577</name>\n            <display-name>drive-002</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6D4AE520B6107B00187D6EFA4CF102DA</disk-uuid>\n            <storage-node>ubuntu-71</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n        <disk>\n            <name>volume-00002578</name>\n            <display-name>drive-003</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6782BCB033086100188691950EF698FF</disk-uuid>\n            <storage-node>ubuntu-61</storage-node>\n            <vpartition-id type=\"integer\">0</vpartition-id>\n            <raid-group-name/>\n            <usage>Available</usage>\n            <status>Available</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </disk>\n    </disks>\n</show-disks-free-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"disks\": [\n      {\n        \"name\": \"volume-00002575\",\n        \"display_name\": \"drive-000\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"50014EE057E2B026\",\n        \"storage_node\": \"ubuntu-sata-51\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"volume-00002576\",\n        \"display_name\": \"drive-001\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6000000000BC614E187D90340A867A8F\",\n        \"storage_node\": \"ubuntu-sata-31\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"volume-00002577\",\n        \"display_name\": \"drive-002\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6D4AE520B6107B00187D6EFA4CF102DA\",\n        \"storage_node\": \"ubuntu-71\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"volume-00002578\",\n        \"display_name\": \"drive-003\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6782BCB033086100188691950EF698FF\",\n        \"storage_node\": \"ubuntu-61\",\n        \"vpartition_id\": 0,\n        \"raid_group_name\": null,\n        \"usage\": \"Available\",\n        \"status\": \"Available\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      }\n    ],\n    \"count\": 4\n  }\n}"
        },
        {
          "uri": "/drives/{id}/rename",
          "method": "POST",
          "description": "Rename a drive.",
          "parameters": [
            {
              "name": "newname",
              "type": "string",
              "required": true,
              "description": "The drive's new name",
              "example": "new-drive-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-disk-response>\n    <disk-name>volume-00002575</disk-name>\n    <status type=\"integer\">0</status>\n</rename-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-00002575\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/drives/{id}/remove",
          "method": "POST",
          "description": "Remove a drive from the VPSA. Only drives which are not part of a Raid Group can be removed",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<remove-disk-response>\n    <disk-name>volume-00002575</disk-name>\n    <status type=\"integer\">0</status>\n</remove-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-00002575\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/drives/{id}/replace",
          "method": "POST",
          "description": "Replace a drive in a Raid Group with a different free drive.",
          "parameters": [
            {
              "name": "toname",
              "description": "The ID of the replacement drive.",
              "type": "string",
              "required": true,
              "example": "drive-001"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<replace-disk-response>\n    <disk-name>volume-00002578</disk-name>\n    <status type=\"integer\">0</status>\n</replace-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-00002578\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/drives/{id}/shred",
          "method": "POST",
          "description": "Shred a drive. The operation can be done only on free drives which are not in a Raid Group. The data in the drive will be lost. This operation is irreversible.",
          "parameters": [
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<shred-disk-response>\n    <disk-name>volume-0000257b</disk-name>\n    <status type=\"integer\">0</status>\n</shred-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-0000257b\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/drives/{id}/cancel_shred",
          "method": "POST",
          "description": "Cancel and abort the drive shredding process.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cancel-shred-disk-response>\n    <disk-name>volume-0000257b</disk-name>\n    <status type=\"integer\">0</status>\n</cancel-shred-disk-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-0000257b\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/drives/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "description": "The interval between data points, in seconds.",
              "example": 1
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_disk_perf-response>\n    <disk-name>volume-00002c4e</disk-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386984996</point>\n        </usage>\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386984997</point>\n        </usage>\n    </usages>\n</get_disk_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"disk_name\": \"volume-00002c4e\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386984996\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386984997\n      }\n    ],\n    \"count\": 20\n  }\n}"
        }
      ]
    },
    {
      "name": "RAID Groups",
      "description": "Operations involving RAID Groups.",
      "methods": [
        {
          "uri": "/raid_groups",
          "method": "GET",
          "description": "Return a list of RAID Groups.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-raid-groups-response>\n    <status type=\"integer\">0</status>\n    <raid-groups-count type=\"integer\">1</raid-groups-count>\n    <raid-groups type=\"array\">\n        <raid-group>\n            <name>RaidGroup-4</name>\n            <display-name>raid_group</display-name>\n            <protection>RAID1</protection>\n            <mirror-num type=\"integer\">3</mirror-num>\n            <stripe-size type=\"integer\">0</stripe-size>\n            <protection-width type=\"integer\">3</protection-width>\n            <capacity type=\"integer\">462</capacity>\n            <available type=\"integer\">462</available>\n            <status>Normal</status>\n            <ssd>NO</ssd>\n            <mismatch-count type=\"integer\">0</mismatch-count>\n            <resync-speed type=\"integer\">0</resync-speed>\n            <min-resync-speed type=\"integer\">0</min-resync-speed>\n            <max-resync-speed type=\"integer\">0</max-resync-speed>\n            <created-at type=\"datetime\">2013-09-25 23:12:26</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:12:26</modified-at>\n        </raid-group>\n    </raid-groups>\n</show-raid-groups-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"raid_groups\": [\n      {\n        \"name\": \"RaidGroup-4\",\n        \"display_name\": \"raid_group\",\n        \"protection\": \"RAID1\",\n        \"mirror_num\": 3,\n        \"stripe_size\": 0,\n        \"protection_width\": 3,\n        \"capacity\": 462,\n        \"available\": 462,\n        \"status\": \"Normal\",\n        \"ssd\": \"NO\",\n        \"mismatch_count\": 0,\n        \"resync_speed\": 0,\n        \"min_resync_speed\": 0,\n        \"max_resync_speed\": 0,\n        \"created_at\": \"2013-09-25 23:12:26 UTC\",\n        \"modified_at\": \"2013-09-25 23:12:26 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}",
          "method": "GET",
          "description": "Return information for one RAID Group.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show_one_raid_group-response>\n    <status type=\"integer\">10009</status>\n    <status-msg>'SSD'</status-msg>\n</show_one_raid_group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 10009,\n    \"message\": \"'SSD'\"\n  }\n}"
        },
        {
          "uri": "/raid_groups/free",
          "method": "GET",
          "description": "Return a list of free RAID Groups which are not part of any Pool.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-free-raid-groups-response>\n    <status type=\"integer\">0</status>\n    <raid-groups-count type=\"integer\">1</raid-groups-count>\n    <raid-groups type=\"array\">\n        <raid-group>\n            <name>RaidGroup-4</name>\n            <display-name>raid_group</display-name>\n            <protection>RAID1</protection>\n            <mirror-num type=\"integer\">3</mirror-num>\n            <stripe-size type=\"integer\">0</stripe-size>\n            <protection-width type=\"integer\">3</protection-width>\n            <capacity type=\"integer\">462</capacity>\n            <available type=\"integer\">462</available>\n            <status>Normal</status>\n            <ssd>NO</ssd>\n            <mismatch-count type=\"integer\">0</mismatch-count>\n            <resync-speed type=\"integer\">0</resync-speed>\n            <min-resync-speed type=\"integer\">0</min-resync-speed>\n            <max-resync-speed type=\"integer\">0</max-resync-speed>\n            <created-at type=\"datetime\">2013-09-25 23:12:26</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:12:26</modified-at>\n        </raid-group>\n    </raid-groups>\n</show-free-raid-groups-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"raid_groups\": [\n      {\n        \"name\": \"RaidGroup-4\",\n        \"display_name\": \"raid_group\",\n        \"protection\": \"RAID1\",\n        \"mirror_num\": 3,\n        \"stripe_size\": 0,\n        \"protection_width\": 3,\n        \"capacity\": 462,\n        \"available\": 462,\n        \"status\": \"Normal\",\n        \"ssd\": \"NO\",\n        \"mismatch_count\": 0,\n        \"resync_speed\": 0,\n        \"min_resync_speed\": 0,\n        \"max_resync_speed\": 0,\n        \"created_at\": \"2013-09-25 23:12:26 UTC\",\n        \"modified_at\": \"2013-09-25 23:12:26 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/raid_groups",
          "method": "POST",
          "description": "Create a RAID Group.\nOperation will fail if drives are not from the same capacity (override with force option)\n",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "description": "The RAID group display name",
              "example": "my-raid-group"
            },
            {
              "name": "protection",
              "type": "string",
              "required": true,
              "options": "RAID1, RAID6",
              "example": "RAID1",
              "description": "protection type"
            },
            {
              "name": "disk",
              "type": "string",
              "required": true,
              "example": "volume-000002fe,volume-000002ff",
              "description": "A comma-separated list of Drive IDs."
            },
            {
              "name": "protection_width",
              "type": "integer",
              "description": "Number of drives in the RAID protection, not including hot spare."
            },
            {
              "name": "stripe_size",
              "type": "integer",
              "description": "Size of the stripe per Disk. Required for RAID6."
            },
            {
              "name": "hot_spare",
              "type": "string",
              "options": "YES, NO"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-raid-group-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</create-raid-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}",
          "method": "DELETE",
          "description": "Delete a RAID Group. The RAID Group must be part of any Pool.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-raid-group-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</delete-raid-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/disks",
          "method": "GET",
          "description": "Return the list of drives in a RAID Group.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show_disks_in_raid_group-response>\n    <status type=\"integer\">0</status>\n    <disks-count type=\"integer\">3</disks-count>\n    <disks type=\"array\">\n        <disk>\n            <name>volume-00002576</name>\n            <display-name>drive-001</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6000000000BC614E187D90340A867A8F</disk-uuid>\n            <storage-node>ubuntu-sata-31</storage-node>\n            <vpartition-id type=\"integer\">4</vpartition-id>\n            <raid-group-name>RaidGroup-4</raid-group-name>\n            <usage>In-use</usage>\n            <status>Normal</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:12:27</modified-at>\n        </disk>\n        <disk>\n            <name>volume-00002577</name>\n            <display-name>drive-002</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>6D4AE520B6107B00187D6EFA4CF102DA</disk-uuid>\n            <storage-node>ubuntu-71</storage-node>\n            <vpartition-id type=\"integer\">4</vpartition-id>\n            <raid-group-name>RaidGroup-4</raid-group-name>\n            <usage>In-use</usage>\n            <status>Normal</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>1e881a0c-97f5-4e1c-8c48-0975e23b</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:12:27</modified-at>\n        </disk>\n        <disk>\n            <name>volume-0000257b</name>\n            <display-name>drive-006</display-name>\n            <disk-type>SATA_465GB_7200RPM</disk-type>\n            <disk-uuid>50014EE057E2B026</disk-uuid>\n            <storage-node>ubuntu-sata-51</storage-node>\n            <vpartition-id type=\"integer\">4</vpartition-id>\n            <raid-group-name>RaidGroup-4</raid-group-name>\n            <usage>In-use</usage>\n            <status>Rebuild</status>\n            <capacity type=\"integer\">465</capacity>\n            <allocation-group>30a32989-5522-4c77-bdb0-caf2c760</allocation-group>\n            <cache>NO</cache>\n            <created-at type=\"datetime\">2013-09-25 11:24:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:30:56</modified-at>\n        </disk>\n    </disks>\n</show_disks_in_raid_group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"disks\": [\n      {\n        \"name\": \"volume-00002576\",\n        \"display_name\": \"drive-001\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6000000000BC614E187D90340A867A8F\",\n        \"storage_node\": \"ubuntu-sata-31\",\n        \"vpartition_id\": 4,\n        \"raid_group_name\": \"RaidGroup-4\",\n        \"usage\": \"In-use\",\n        \"status\": \"Normal\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 23:12:27 UTC\"\n      },\n      {\n        \"name\": \"volume-00002577\",\n        \"display_name\": \"drive-002\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"6D4AE520B6107B00187D6EFA4CF102DA\",\n        \"storage_node\": \"ubuntu-71\",\n        \"vpartition_id\": 4,\n        \"raid_group_name\": \"RaidGroup-4\",\n        \"usage\": \"In-use\",\n        \"status\": \"Normal\",\n        \"capacity\": 465,\n        \"allocation_group\": \"1e881a0c-97f5-4e1c-8c48-0975e23b\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 23:12:27 UTC\"\n      },\n      {\n        \"name\": \"volume-0000257b\",\n        \"display_name\": \"drive-006\",\n        \"disk_type\": \"SATA_465GB_7200RPM\",\n        \"disk_uuid\": \"50014EE057E2B026\",\n        \"storage_node\": \"ubuntu-sata-51\",\n        \"vpartition_id\": 4,\n        \"raid_group_name\": \"RaidGroup-4\",\n        \"usage\": \"In-use\",\n        \"status\": \"Rebuild\",\n        \"capacity\": 465,\n        \"allocation_group\": \"30a32989-5522-4c77-bdb0-caf2c760\",\n        \"cache\": \"NO\",\n        \"created_at\": \"2013-09-25 11:24:25 UTC\",\n        \"modified_at\": \"2013-09-25 23:30:56 UTC\"\n      }\n    ],\n    \"count\": 3\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/rename",
          "method": "POST",
          "description": "Update a RAID Group's name.",
          "parameters": [
            {
              "name": "newname",
              "type": "string",
              "description": "Raid group new name",
              "required": true,
              "example": "new-raid-group-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-raid-group-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</rename-raid-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/resync_speed",
          "method": "POST",
          "description": "Update a RAID Group's resync speed.",
          "parameters": [
            {
              "name": "min",
              "description": "Minimum speed in MB per second. Resync is done at minimum speed while there are Server IOs",
              "type": "integer",
              "required": true,
              "example": 10
            },
            {
              "name": "max",
              "description": "Maximum speed in MB per second. Resync is done at maximum speed when there are no Server IOs",
              "type": "integer",
              "required": true,
              "example": 100
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-resync-speed-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</update-resync-speed-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/scrub",
          "method": "POST",
          "description": "Trigger a Media Scan of the RAID Group. Parity inconsistency will be fixed. The result of the process will be logged in the VPSA Event-Log.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<scrub-raid-group-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</scrub-raid-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/pause_scrub",
          "method": "POST",
          "description": "Pause the Media Scan of a RAID Group.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-scrub-resync-speed-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</pause-scrub-resync-speed-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/hot_spares",
          "method": "POST",
          "description": "Add a hot spare to a RAID Group.",
          "parameters": [
            {
              "name": "disk",
              "description": "ID of the Drive to add as a Hot Spare.",
              "required": true,
              "type": "string",
              "example": "drive-002"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add-hot-spare-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</add-hot-spare-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/hot_spares/remove",
          "method": "POST",
          "description": "Remove the hot spare from a RAID Group.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<remove-hot-spare-response>\n    <raidgroup-name>RaidGroup-4</raidgroup-name>\n    <status type=\"integer\">0</status>\n</remove-hot-spare-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raidgroup_name\": \"RaidGroup-4\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/raid_groups/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_raid_group_perf-response>\n    <raid-group-name>RaidGroup-4</raid-group-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985241</point>\n        </usage>\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985242</point>\n        </usage>\n    </usages>\n</get_raid_group_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"raid_group_name\": \"RaidGroup-4\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985241\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985242\n      }\n    ],\n    \"count\": 20\n  }\n}"
        }
      ]
    },
    {
      "name": "Pools",
      "description": "Operations involving Pools.",
      "methods": [
        {
          "uri": "/pools",
          "method": "GET",
          "description": "Show all Pools.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-pools-response>\n    <status type=\"integer\">0</status>\n    <pools-count type=\"integer\">1</pools-count>\n    <pools type=\"array\">\n        <pool>\n            <name>pool-00000001</name>\n            <display-name>poolrenamed</display-name>\n            <status>normal</status>\n            <capacity type=\"integer\">462</capacity>\n            <available-capacity type=\"float\">451.875</available-capacity>\n            <version type=\"integer\">2</version>\n            <data-type />\n            <mount-sync />\n            <access-time-update />\n            <raid-group-name>raid_group_renamed</raid-group-name>\n            <mode>simple</mode>\n            <stripe-size type=\"integer\">64</stripe-size>\n            <cache>NO</cache>\n            <cow-cache>NO</cow-cache>\n            <capacity-mode>normal</capacity-mode>\n            <capacity-history type=\"integer\">10</capacity-history>\n            <alert-mode type=\"integer\">360</alert-mode>\n            <protected-mode type=\"integer\">60</protected-mode>\n            <emergency-mode type=\"integer\">100</emergency-mode>\n            <chunk-size type=\"integer\">256</chunk-size>\n            <type>OLTP</type>\n            <created-at type=\"datetime\">2013-09-25 23:53:52</created-at>\n            <modified-at type=\"datetime\">2013-09-26 00:05:16</modified-at>\n        </pool>\n    </pools>\n</show-pools-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"pools\": [\n      {\n        \"name\": \"pool-00000001\",\n        \"display_name\": \"poolrenamed\",\n        \"status\": \"normal\",\n        \"capacity\": 462,\n        \"available_capacity\": 451.875,\n        \"version\": 2,\n        \"data_type\": null,\n        \"mount_sync\": null,\n        \"access_time_update\": null,\n        \"raid_group_name\": \"raid_group_renamed\",\n        \"mode\": \"simple\",\n        \"stripe_size\": 64,\n        \"cache\": \"NO\",\n        \"cow_cache\": \"NO\",\n        \"capacity_mode\": \"normal\",\n        \"capacity_history\": 10,\n        \"alert_mode\": 360,\n        \"protected_mode\": 60,\n        \"emergency_mode\": 100,\n        \"chunk_size\": 256,\n        \"type\": \"OLTP\",\n        \"created_at\": \"2013-09-25 23:53:52 UTC\",\n        \"modified_at\": \"2013-09-26 00:05:16 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/pools/{id}",
          "method": "GET",
          "description": "Show one Pool details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-pool-response>\n    <status type=\"integer\">0</status>\n    <pool>\n        <name>pool-00000001</name>\n        <display-name>poolrenamed</display-name>\n        <status>normal</status>\n        <capacity type=\"integer\">462</capacity>\n        <available-capacity type=\"float\">451.875</available-capacity>\n        <version type=\"integer\">2</version>\n        <data-type />\n        <mount-sync />\n        <access-time-update />\n        <raid-group-name>raid_group_renamed</raid-group-name>\n        <mode>simple</mode>\n        <stripe-size type=\"integer\">64</stripe-size>\n        <cache>NO</cache>\n        <cow-cache>NO</cow-cache>\n        <capacity-mode>normal</capacity-mode>\n        <capacity-history type=\"integer\">10</capacity-history>\n        <alert-mode type=\"integer\">360</alert-mode>\n        <protected-mode type=\"integer\">60</protected-mode>\n        <emergency-mode type=\"integer\">100</emergency-mode>\n        <chunk-size type=\"integer\">256</chunk-size>\n        <type>OLTP</type>\n        <created-at type=\"datetime\">2013-09-25 23:53:52</created-at>\n        <modified-at type=\"datetime\">2013-09-26 00:05:16</modified-at>\n    </pool>\n</show-one-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"pool\": {\n      \"name\": \"pool-00000001\",\n      \"display_name\": \"poolrenamed\",\n      \"status\": \"normal\",\n      \"capacity\": 462,\n      \"available_capacity\": 451.875,\n      \"version\": 2,\n      \"data_type\": null,\n      \"mount_sync\": null,\n      \"access_time_update\": null,\n      \"raid_group_name\": \"raid_group_renamed\",\n      \"mode\": \"simple\",\n      \"stripe_size\": 64,\n      \"cache\": \"NO\",\n      \"cow_cache\": \"NO\",\n      \"capacity_mode\": \"normal\",\n      \"capacity_history\": 10,\n      \"alert_mode\": 360,\n      \"protected_mode\": 60,\n      \"emergency_mode\": 100,\n      \"chunk_size\": 256,\n      \"type\": \"OLTP\",\n      \"created_at\": \"2013-09-25 23:53:52 UTC\",\n      \"modified_at\": \"2013-09-26 00:05:16 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/pools",
          "method": "POST",
          "description": "Create a Pool.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "description": "The new pool display name",
              "example": "new-pool"
            },
            {
              "name": "capacity",
              "type": "string",
              "required": true,
              "productType": "hybrid",
              "description": "The new pool capacity followed by the letter G",
              "example": "30G"
            },
            {
              "name": "cache",
              "type": "string",
              "options": "YES, NO",
              "required": false,
              "productType": "hybrid",
              "default": false,
              "description": "Indicate whether the Pool will utilize the VPSA SSD cache. All Pools marked YES share the same cache capacity."
            },
            {
              "name": "cowcache",
              "type": "boolean",
              "productType": "hybrid",
              "required": false,
              "default": true,
              "description": "Indicate whether snapshot Copy-On-Write operations are Cached. Default: YES"
            },
            {
              "name": "mode",
              "type": "string",
              "options": "stripe, simple",
              "default": "simple",
              "required": false,
              "productType": "hybrid",
              "description": "Indicate whether RAID groups are concatinated or striped inside the Pool."
            },
            {
              "name": "raid_groups",
              "type": "string",
              "required": true,
              "description": "Comma separated list of RAID Group IDs.",
              "example": "raid-00000001"
            },
            {
              "name": "pooltype",
              "type": "string",
              "ignoreOptionsSeperator": 1,
              "options": "<br/><br/><span class=badge badge-danger badge-xs>VPSA Storage Array</span><br/> Repository Storage, Transactional Workloads, Archival Storage, Depot Storage <br/><span class=badge badge-danger badge-xs>VPSA Flash Array</span><br/> IOPs-Optimized, Balanced, Throughput-Optimized",
              "description": "The new pool type",
              "example": "Repository Storage"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</create-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}",
          "method": "DELETE",
          "description": "Delete a Pool. The Pool must be empty.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</delete-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/rename",
          "method": "POST",
          "description": "Rename a Pool.",
          "parameters": [
            {
              "name": "new_name",
              "type": "string",
              "required": true,
              "description": "The pool new name",
              "example": "new-pool-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</rename-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/raid_groups",
          "method": "GET",
          "description": "Return the list of RAID Groups in a Pool.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-raid-groups-in-pool-response>\n    <status type=\"integer\">0</status>\n    <raid-groups-count type=\"integer\">1</raid-groups-count>\n    <raid-groups type=\"array\">\n        <raid-group>\n            <name>RaidGroup-4</name>\n            <display-name>raid_group_renamed</display-name>\n            <protection>RAID1</protection>\n            <mirror-num type=\"integer\">3</mirror-num>\n            <stripe-size type=\"integer\">0</stripe-size>\n            <protection-width type=\"integer\">3</protection-width>\n            <capacity type=\"integer\">462</capacity>\n            <available type=\"integer\">0</available>\n            <status>Recovering 37%</status>\n            <ssd>NO</ssd>\n            <mismatch-count type=\"integer\">0</mismatch-count>\n            <resync-speed type=\"integer\">74</resync-speed>\n            <min-resync-speed type=\"integer\">28</min-resync-speed>\n            <max-resync-speed type=\"integer\">75</max-resync-speed>\n            <created-at type=\"datetime\">2013-09-25 23:12:26</created-at>\n            <modified-at type=\"datetime\">2013-09-25 23:12:26</modified-at>\n        </raid-group>\n    </raid-groups>\n</show-raid-groups-in-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"raid_groups\": [\n      {\n        \"name\": \"RaidGroup-4\",\n        \"display_name\": \"raid_group_renamed\",\n        \"protection\": \"RAID1\",\n        \"mirror_num\": 3,\n        \"stripe_size\": 0,\n        \"protection_width\": 3,\n        \"capacity\": 462,\n        \"available\": 0,\n        \"status\": \"Recovering 37%\",\n        \"ssd\": \"NO\",\n        \"mismatch_count\": 0,\n        \"resync_speed\": 74,\n        \"min_resync_speed\": 28,\n        \"max_resync_speed\": 75,\n        \"created_at\": \"2013-09-25 23:12:26 UTC\",\n        \"modified_at\": \"2013-09-25 23:12:26 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/pools/{id}/volumes",
          "method": "GET",
          "description": "Return the list of Volumes in a Pool.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-volumes-in-pool-response>\n    <status type=\"integer\">0</status>\n    <volumes-count type=\"integer\">5</volumes-count>\n    <volumes type=\"array\">\n      <volume>\n            <name>volume-00000004</name>\n            <display-name>Example_Volume</display-name>\n            <cg-display-name>Example_Volume</cg-display-name>\n            <cg-name>cg-0000003c</cg-name>\n            <cg-user-created>NO</cg-user-created>\n            <pool-display-name>Pool_0</pool-display-name>\n            <pool-name>pool-00000002</pool-name>\n            <status>In-use    </status>\n            <virtual-capacity type=\"integer\">600</virtual-capacity>\n            <server-name>Multiple(2)</server-name>\n            <data-type>File-System</data-type>\n            <thin>NO</thin>\n            <encryption>NO</encryption>\n            <encryption-key-size>0</encryption-key-size>\n            <allocated-capacity type=\"float\">570.895507812</allocated-capacity>\n            <data-copies-capacity type=\"float\">14.6979980469</data-copies-capacity>\n            <access-type>NFS</access-type>\n            <read-only>NO</read-only>\n            <nfs-export-path>172.31.224.103:/export/Example_Volume</nfs-export-path>\n            <smb-export-path>\\\\172.31.224.103\\Example_Volume</smb-export-path>\n            <mount-sync>YES</mount-sync>\n            <atime-update>NO</atime-update>\n            <read-ahead-kb type=\"integer\">512</read-ahead-kb>\n            <ext-metering>NO</ext-metering>\n            <images-repo>NO</images-repo>\n            <nfs-root-squash>NO</nfs-root-squash>\n            <smb-only>NO</smb-only>\n            <smb-guest>NO</smb-guest>\n            <smb-windows-acl>NO</smb-windows-acl>\n            <smb-map-archive>YES</smb-map-archive>\n            <smb-file-create-mask>0744</smb-file-create-mask>\n            <smb-dir-create-mask>0755</smb-dir-create-mask>\n            <smb-aio-size type=\"integer\">1</smb-aio-size>\n            <smb-browseable>YES</smb-browseable>\n            <smb-hidden-files/>\n            <smb-encryption-mode>off</smb-encryption-mode>\n            <smb-hide-unreadable>NO</smb-hide-unreadable>\n            <smb-hide-unwriteable>NO</smb-hide-unwriteable>\n            <smb-hide-dot-files>NO</smb-hide-dot-files>\n            <smb-store-dos-attributes>NO</smb-store-dos-attributes>\n            <smb-enable-oplocks>YES</smb-enable-oplocks>\n            <capacity-history type=\"integer\">60</capacity-history>\n            <alert-mode type=\"integer\">360</alert-mode>\n            <uquota-state>off</uquota-state>\n            <gquota-state>off</gquota-state>\n            <pquota-state>off</pquota-state>\n            <target/>\n            <lun/>\n            <cache/>\n            <tenant-id type=\"integer\">11</tenant-id>\n            <has-mirror>NO</has-mirror>\n            <has-backup>NO</has-backup>\n            <has-snapshots>YES</has-snapshots>\n            <shadow-copy-enabled>NO</shadow-copy-enabled>\n            <is-shadow-copy-clone>NO</is-shadow-copy-clone>\n            <read-iops-limit>0</read-iops-limit>\n            <read-mbps-limit>0</read-mbps-limit>\n            <write-iops-limit>0</write-iops-limit>\n            <write-mbps-limit>0</write-mbps-limit>\n            <thresholds/>\n            <comment/>\n            <server-ext-names>srv-00000001,srv-00000002</server-ext-names>\n            <created-at type=\"datetime\">2018-02-23T22:54:25+0000</created-at>\n            <modified-at type=\"datetime\">2018-10-27T02:45:20+0000</modified-at>\n          </volume>\n    </volumes>\n</show-volumes-in-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000004\",\n        \"display_name\": \"Example_Volume\",\n        \"cg_display_name\": \"Example_Volume\",\n        \"cg_name\": \"cg-0000003c\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"Pool_0\",\n        \"pool_name\": \"pool-00000002\",\n        \"status\": \"In-use    \",\n        \"virtual_capacity\": 600,\n        \"server_name\": \"Multiple(2)\",\n        \"data_type\": \"File-System\",\n        \"thin\": \"NO\",\n        \"encryption\": \"NO\",\n        \"encryption_key_size\": \"0\",\n        \"allocated_capacity\": 570.895507812,\n        \"data_copies_capacity\": 14.6979980469,\n        \"access_type\": \"NFS\",\n        \"read_only\": \"NO\",\n        \"nfs_export_path\": \"172.31.224.103:/export/Example_Volume\",\n        \"smb_export_path\": \"\\\\\\\\172.31.224.103\\\\Example_Volume\",\n        \"mount_sync\": \"YES\",\n        \"atime_update\": \"NO\",\n        \"read_ahead_kb\": 512,\n        \"ext_metering\": \"NO\",\n        \"images_repo\": \"NO\",\n        \"nfs_root_squash\": \"NO\",\n        \"smb_only\": \"NO\",\n        \"smb_guest\": \"NO\",\n        \"smb_windows_acl\": \"NO\",\n        \"smb_map_archive\": \"YES\",\n        \"smb_file_create_mask\": \"0744\",\n        \"smb_dir_create_mask\": \"0755\",\n        \"smb_aio_size\": 1,\n        \"smb_browseable\": \"YES\",\n        \"smb_hidden_files\": null,\n        \"smb_encryption_mode\": \"off\",\n        \"smb_hide_unreadable\": \"NO\",\n        \"smb_hide_unwriteable\": \"NO\",\n        \"smb_hide_dot_files\": \"NO\",\n        \"smb_store_dos_attributes\": \"NO\",\n        \"smb_enable_oplocks\": \"YES\",\n        \"capacity_history\": 60,\n        \"alert_mode\": 360,\n        \"uquota_state\": \"off\",\n        \"gquota_state\": \"off\",\n        \"pquota_state\": \"off\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"tenant_id\": 11,\n        \"has_mirror\": \"NO\",\n        \"has_backup\": \"NO\",\n        \"has_snapshots\": \"YES\",\n        \"shadow_copy_enabled\": \"NO\",\n        \"is_shadow_copy_clone\": \"NO\",\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"thresholds\": null,\n        \"comment\": null,\n        \"server_ext_names\": \"srv-00000001,srv-00000002\",\n        \"created_at\": \"2018-02-23 22:54:25 UTC\",\n        \"modified_at\": \"2018-10-27 02:45:20 UTC\"\n      }\n    ],\n    \"count\": 5\n  }\n}"
        },
        {
          "uri": "/pools/{id}/expand",
          "method": "POST",
          "description": "Add additional RAID Groups Or OBS Tier to a Pool.",
          "parameters": [
            {
              "name": "raid_groups.",
              "type": "string",
              "description": "Cannot be used with `obsdestname`. Comma separated list of RAID Group IDs.",
              "example": "raid-00000001"
            },
            {
              "name": "capacity",
              "type": "string",
              "description": "Capacity in GB followed by the letter G.",
              "example": "30G"
            },
            {
              "name": "obsdestname",
              "type": "string",
              "description": "Object storage destination name. Cannot be used with `raid_groups`",
              "example": "obsdst-00000001"
            },
            {
              "name": "cloud_size",
              "type": "string",
              "description": "Object storage size (multiple of 20).",
              "example": "40"
            },
            {
              "name": "sse",
              "type": "string",
              "description": "Encryption type.",
              "example": "AES256"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<expand-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</expand-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/shrink",
          "method": "POST",
          "description": "Remove a RAID Group / Shrink OBS from a Pool.",
          "parameters": [
            {
              "name": "raid_group",
              "type": "string",
              "description": "RAID Group ID.",
              "example": "RaidGroup-4"
            },
            {
              "name": "obsshrinksize",
              "type": "integer",
              "description": "OBS size to shrink. (Multiples of 20)",
              "example": 40
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<shrink-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</shrink-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/cancel_shrink",
          "method": "POST",
          "description": "Cancel a Pool Shrink.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cancel-shrink-pool-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</cancel-shrink-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/update_ssd_cool_off",
          "method": "POST",
          "description": "Update ssd cool off.",
          "parameters": [
            {
              "name": "cool_off_hours",
              "required": true,
              "type": "integer",
              "example": 2
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-pool-ssd-cool-off-period-response>\n    <status type=\"integer\">0</status>\n</update-pool-ssd-cool-off-period-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/update_protection",
          "method": "POST",
          "description": "Update free capacity alert notification settings for a Pool.",
          "parameters": [
            {
              "name": "capacityhistory",
              "type": "integer",
              "description": "Window size in minutes which is used to calculate the rate of which free Pool capacity is consumed. This rate is used to calculate the estimated time until a Pool is full."
            },
            {
              "name": "effectivecapacityhistory",
              "productType": "AFA",
              "type": "integer",
              "description": "Window size in minutes which is used to calculate the rate of which free Pool effective capacity is consumed. This rate is used to calculate the estimated time until a Pool is full."
            },
            {
              "name": "alertmode",
              "type": "integer",
              "description": "Send an alert when it is estimated that the Pool will be at full capacity in this many minutes."
            },
            {
              "name": "effectivealertmode",
              "productType": "AFA",
              "type": "integer",
              "description": "Send an alert when it is estimated that the Pool will be at full effective capacity in this many minutes."
            },
            {
              "name": "protectedmode",
              "type": "integer",
              "description": "Block Volume/Share/Pool creation when it's estimated that the Pool will be full in this many minutes."
            },
            {
              "name": "effectiveprotectedmode",
              "productType": "AFA",
              "type": "integer",
              "description": "Block Volume/Share/Pool creation when it's estimated that the Pool effective capacity will be full in this many minutes."
            },
            {
              "name": "emergencymode",
              "type": "integer",
              "description": "Delete snapshots, starting with the oldest, when the Pool has less than this number of GB left."
            },
            {
              "name": "effectiveemergencymode",
              "productType": "AFA",
              "type": "integer",
              "description": "Delete snapshots, starting with the oldest, when the Pool effective capacity has less than this number of GB left."
            }
          ],
          "reponse": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-pool-protection-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</update-pool-protection-response>\n"
        },
        {
          "uri": "/pools/{id}/destination_volumes",
          "method": "GET",
          "description": "List Remote Mirroring Destination Volumes in a Pool.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-dst-volumes-in-pool-response>\n    <status type=\"integer\">0</status>\n    <volumes-count type=\"integer\">1</volumes-count>\n    <volumes type=\"array\">\n        <volume>\n            <name>volume-00000001</name>\n            <display-name>volume</display-name>\n            <cg-display-name>remotevolume</cg-display-name>\n            <cg-name>cg-00000001</cg-name>\n            <cg-user-created>NO</cg-user-created>\n            <pool-display-name>pool</pool-display-name>\n            <pool-name>pool-00000001</pool-name>\n            <virtual-capacity type=\"integer\">300</virtual-capacity>\n            <data-type>BLOCK</data-type>\n            <thin>YES</thin>\n            <created-at type=\"datetime\">2013-09-27 02:10:21</created-at>\n            <modified-at type=\"datetime\">2013-09-27 02:10:21</modified-at>\n        </volume>\n    </volumes>\n</show-dst-volumes-in-pool-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000001\",\n        \"display_name\": \"volume\",\n        \"cg_display_name\": \"remotevolume\",\n        \"cg_name\": \"cg-00000001\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"pool\",\n        \"pool_name\": \"pool-00000001\",\n        \"virtual_capacity\": 300,\n        \"data_type\": \"BLOCK\",\n        \"thin\": \"YES\",\n        \"created_at\": \"2013-09-27 02:10:21 UTC\",\n        \"modified_at\": \"2013-09-27 02:10:21 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/pools/{id}/toggle_cache",
          "method": "POST",
          "productType": "hybrid",
          "parameters": [
            {
              "name": "command",
              "type": "string",
              "required": true,
              "description": "argument to set enable / disable cache",
              "example": "enable",
              "options": "enable|disable"
            },
            {
              "name": "cowcache",
              "type": "boolean",
              "description": "argument to set COW caching",
              "example": true
            }
          ],
          "description": "Toggle cache for a Pool.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<attach-pool-to-cache-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</attach-pool-to-cache-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/cow_cache",
          "method": "POST",
          "productType": "hybrid",
          "parameters": [
            {
              "name": "cowcache",
              "type": "boolean",
              "description": "argument to set COW caching",
              "example": true
            }
          ],
          "description": "Toggle copy on write cache for a Pool.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-pool-cow-cache-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n</update-pool-cow-cache-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/volumes_in_recycle_bin",
          "method": "GET",
          "description": "Show a pool's volumes in recycle bin",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-volumes-in-recycle-bin-response>\n  <status type=\"integer\">0</status>\n  <volumes-count type=\"integer\">1</volumes-count>\n  <volumes type=\"array\">\n    <volume>\n      <name>volume-0000000f</name>\n      <display-name>test</display-name>\n      ...\n      <created-at type=\"datetime\">2015-06-25T15:29:16+0300</created-at>\n      <modified-at type=\"datetime\">2015-06-25T15:29:24+0300</modified-at>\n    </volume>\n  </volumes>\n</show-volumes-in-recycle-bin-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      \"\\n      \\n      \\n      ...\\n      \\n      \\n    \"\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/pools/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_pool_perf-response>\n    <pool-name>pool-00000001</pool-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985186</point>\n        </usage>\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985187</point>\n        </usage>\n    </usages>\n</get_pool_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"pool_name\": \"pool-00000001\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985186\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985187\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/pools/{id}/tags",
          "method": "GET",
          "description": "Get pool tags.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-object-tags-response>\n  <status type=\"integer\">0</status>\n  <tags-count type=\"integer\">2</tags-count>\n  <tags type=\"array\">\n    <tag>\n      <name>tag-00000003</name>\n      <key>key1</key>\n      <value>value1</value>\n    </tag>\n    <tag>\n      <name>tag-00000005</name>\n      <key>key2</key>\n      <value>value2</value>\n    </tag>\n  </tags>\n</show-object-tags-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"tags\": [\n      {\n        \"name\": \"tag-00000003\",\n        \"key\": \"key1\",\n        \"value\": \"value1\"\n      },\n      {\n        \"name\": \"tag-00000005\",\n        \"key\": \"key2\",\n        \"value\": \"value2\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/pools/{id}/tags",
          "method": "POST",
          "description": "Create a tag for pool.",
          "parameters": [
            {
              "name": "key",
              "type": "string",
              "description": "The tag name.",
              "required": true,
              "example": "tag_key"
            },
            {
              "name": "value",
              "type": "string",
              "description": "The tag value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add-object-tag-response>\n  <tag-name>tag-00000019</tag-name>\n  <status type=\"integer\">0</status>\n</add-object-tag-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000019\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/tags/{tag_key}",
          "method": "PUT",
          "description": "Update a tag for pool.",
          "parameters": [
            {
              "name": "value",
              "type": "string",
              "description": "The tag new value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</update-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/pools/{id}/tags/{tag_key}",
          "method": "DELETE",
          "description": "Deletes a tag from pool.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</delete-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Volumes",
      "description": "Operations involving Volumes.",
      "methods": [
        {
          "uri": "/volumes",
          "method": "GET",
          "description": "Show all Volumes.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            },
            {
              "name": "showonlyblock",
              "type": "string",
              "required": false,
              "description": "Show only block volumes.",
              "options": "YES, NO",
              "example": "YES"
            },
            {
              "name": "showonlyfile",
              "type": "string",
              "required": false,
              "description": "Show only NAS shares.",
              "options": "YES, NO",
              "example": "YES"
            },
            {
              "name": "display_name",
              "type": "string",
              "required": false,
              "description": "Filter volumes by name.",
              "example": "vol000"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-volumes-response>\n    <status type=\"integer\">0</status>\n    <volumes-count type=\"integer\">2</volumes-count>\n    <volumes type=\"array\">\n        <volume>\n          <name>volume-00000001</name>\n          <display-name>smb1</display-name>\n          <cg-display-name>smb1</cg-display-name>\n          <cg-name>cg-00000001</cg-name>\n          <cg-user-created>NO</cg-user-created>\n          <pool-display-name>RAID-10-Pool-1</pool-display-name>\n          <pool-name>pool-00010001</pool-name>\n          <pool-version type=\"integer\">2</pool-version>\n          <status>In-use</status>\n          <virtual-capacity type=\"integer\">500</virtual-capacity>\n          <server-name>VM110</server-name>\n          <provisioned-capacity type=\"integer\">500</provisioned-capacity>\n          <server-ext-names>srv-00000001</server-ext-names>\n          <life-cycle-policy-display-name nil=\"true\"/>\n          <life-cycle-policy-ext-name nil=\"true\"/>\n          <data-type>File-System</data-type>\n          <thin>NO</thin>\n          <encryption>NO</encryption>\n          <encryption-key-size>0</encryption-key-size>\n          <total-capacity type=\"float\">499.51171875</total-capacity>\n          <available-capacity type=\"float\">485.34765625</available-capacity>\n          <num-of-filesystem-objects type=\"integer\">13876</num-of-filesystem-objects>\n          <capacity-mode>normal</capacity-mode>\n          <allocated-capacity type=\"float\">21.025390625</allocated-capacity>\n          <data-copies-capacity type=\"float\">52.0400390625</data-copies-capacity>\n          <access-type>SMB</access-type>\n          <read-only>NO</read-only>\n          <nfs-export-path>10.2.4.157:/export/smb1</nfs-export-path>\n          <smb-export-path>\\\\10.2.4.157\\smb1</smb-export-path>\n          <additional-smb-export-paths-count type=\"integer\">0</additional-smb-export-paths-count>\n          <mount-sync>YES</mount-sync>\n          <atime-update>YES</atime-update>\n          <read-ahead-kb type=\"integer\">512</read-ahead-kb>\n          <ext-metering>NO</ext-metering>\n          <images-repo>NO</images-repo>\n          <flc-db>NO</flc-db>\n          <audit-repo>NO</audit-repo>\n          <nfs-root-squash>NO</nfs-root-squash>\n          <nfs-all-squash>NO</nfs-all-squash>\n          <nfs-anon-uid nil=\"true\"/>\n          <nfs-anon-gid nil=\"true\"/>\n          <smb-only>NO</smb-only>\n          <smb-guest>NO</smb-guest>\n          <smb-windows-acl>YES</smb-windows-acl>\n          <smb-map-archive>YES</smb-map-archive>\n          <smb-file-create-mask>0744</smb-file-create-mask>\n          <smb-dir-create-mask>0755</smb-dir-create-mask>\n          <smb-aio-size type=\"integer\">1</smb-aio-size>\n          <smb-browseable>YES</smb-browseable>\n          <smb-hidden-files nil=\"true\"/>\n          <smb-encryption-mode>off</smb-encryption-mode>\n          <smb-case-sensitive>AUTO</smb-case-sensitive>\n          <smb-mangled-names>YES</smb-mangled-names>\n          <smb-hide-unreadable>NO</smb-hide-unreadable>\n          <smb-hide-unwriteable>NO</smb-hide-unwriteable>\n          <smb-hide-dot-files>NO</smb-hide-dot-files>\n          <smb-store-dos-attributes>NO</smb-store-dos-attributes>\n          <smb-enable-oplocks>YES</smb-enable-oplocks>\n          <audit-enable>YES</audit-enable>\n          <capacity-history type=\"integer\">60</capacity-history>\n          <alert-mode type=\"integer\">360</alert-mode>\n          <emergency-mode-mb type=\"integer\">51200</emergency-mode-mb>\n          <auto-expand-on-emergency>NO</auto-expand-on-emergency>\n          <auto-expand-by type=\"integer\">0</auto-expand-by>\n          <max-capacity type=\"integer\">102400</max-capacity>\n          <uquota-state>off</uquota-state>\n          <gquota-state>off</gquota-state>\n          <pquota-state>off</pquota-state>\n          <target nil=\"true\"/>\n          <lun nil=\"true\"/>\n          <cache nil=\"true\"/>\n          <tenant-id type=\"integer\">10</tenant-id>\n          <has-mirror>NO</has-mirror>\n          <has-backup>NO</has-backup>\n          <is-remote-clone-source>NO</is-remote-clone-source>\n          <has-snapshots>NO</has-snapshots>\n          <shadow-copy-enabled>YES</shadow-copy-enabled>\n          <is-shadow-copy-clone>NO</is-shadow-copy-clone>\n          <read-iops-limit>0</read-iops-limit>\n          <read-mbps-limit>0</read-mbps-limit>\n          <write-iops-limit>0</write-iops-limit>\n          <write-mbps-limit>0</write-mbps-limit>\n          <read-iops-capping>0</read-iops-capping>\n          <read-mbps-capping>0</read-mbps-capping>\n          <write-iops-capping>0</write-iops-capping>\n          <write-mbps-capping>0</write-mbps-capping>\n          <compress>NO/Globally disabled</compress>\n          <dedupe>NO/Globally disabled</dedupe>\n          <mtr-histograms>NO</mtr-histograms>\n          <flc-state>FLC_NONE</flc-state>\n          <flc-scan-state>FLC_SCAN_NONE</flc-scan-state>\n          <flc-scan-progress type=\"float\">0.0</flc-scan-progress>\n          <flc-scan-remaining-time-seconds type=\"integer\">0</flc-scan-remaining-time-seconds>\n          <thresholds nil=\"true\"/>\n          <comment nil=\"true\"/>\n          <created-at>2021-09-09T16:31:28+0300</created-at>\n          <modified-at>2021-09-14T14:49:53+0300</modified-at>\n          <flc-policy-name nil=\"true\"/>\n        </volume>\n        <volume>\n          <name>volume-00000002</name>\n          <display-name>smb2</display-name>\n          <cg-display-name>smb2</cg-display-name>\n          <cg-name>cg-00000002</cg-name>\n          <cg-user-created>NO</cg-user-created>\n          <pool-display-name>RAID-10-Pool-1</pool-display-name>\n          <pool-name>pool-00010001</pool-name>\n          <pool-version type=\"integer\">2</pool-version>\n          <status>In-use</status>\n          <provisioned-capacity type=\"integer\">500</provisioned-capacity>\n          <server-name>VM110</server-name>\n          <server-ext-names>srv-00000001</server-ext-names>\n          <life-cycle-policy-display-name nil=\"true\"/>\n          <life-cycle-policy-ext-name nil=\"true\"/>\n          <data-type>File-System</data-type>\n          <thin>NO</thin>\n          <encryption>NO</encryption>\n          <encryption-key-size>0</encryption-key-size>\n          <total-capacity type=\"float\">499.51171875</total-capacity>\n          <available-capacity type=\"float\">492.411132812</available-capacity>\n          <num-of-filesystem-objects type=\"integer\">6199</num-of-filesystem-objects>\n          <capacity-mode>normal</capacity-mode>\n          <allocated-capacity type=\"float\">21.234375</allocated-capacity>\n          <data-copies-capacity type=\"float\">61.953125</data-copies-capacity>\n          <access-type>SMB</access-type>\n          <read-only>NO</read-only>\n          <nfs-export-path>10.2.4.157:/export/smb2</nfs-export-path>\n          <smb-export-path>\\\\10.2.4.157\\smb2</smb-export-path>\n          <additional-smb-export-paths-count type=\"integer\">0</additional-smb-export-paths-count>\n          <mount-sync>YES</mount-sync>\n          <atime-update>YES</atime-update>\n          <read-ahead-kb type=\"integer\">512</read-ahead-kb>\n          <ext-metering>NO</ext-metering>\n          <images-repo>NO</images-repo>\n          <flc-db>NO</flc-db>\n          <audit-repo>NO</audit-repo>\n          <nfs-root-squash>NO</nfs-root-squash>\n          <nfs-all-squash>NO</nfs-all-squash>\n          <nfs-anon-uid nil=\"true\"/>\n          <nfs-anon-gid nil=\"true\"/>\n          <smb-only>NO</smb-only>\n          <smb-guest>NO</smb-guest>\n          <smb-windows-acl>YES</smb-windows-acl>\n          <smb-map-archive>YES</smb-map-archive>\n          <smb-file-create-mask>0744</smb-file-create-mask>\n          <smb-dir-create-mask>0755</smb-dir-create-mask>\n          <smb-aio-size type=\"integer\">1</smb-aio-size>\n          <smb-browseable>YES</smb-browseable>\n          <smb-hidden-files nil=\"true\"/>\n          <smb-encryption-mode>off</smb-encryption-mode>\n          <smb-case-sensitive>AUTO</smb-case-sensitive>\n          <smb-mangled-names>YES</smb-mangled-names>\n          <smb-hide-unreadable>NO</smb-hide-unreadable>\n          <smb-hide-unwriteable>NO</smb-hide-unwriteable>\n          <smb-hide-dot-files>NO</smb-hide-dot-files>\n          <smb-store-dos-attributes>NO</smb-store-dos-attributes>\n          <smb-enable-oplocks>YES</smb-enable-oplocks>\n          <audit-enable>YES</audit-enable>\n          <capacity-history type=\"integer\">60</capacity-history>\n          <alert-mode type=\"integer\">360</alert-mode>\n          <emergency-mode-mb type=\"integer\">51200</emergency-mode-mb>\n          <auto-expand-on-emergency>NO</auto-expand-on-emergency>\n          <auto-expand-by type=\"integer\">0</auto-expand-by>\n          <max-capacity type=\"integer\">102400</max-capacity>\n          <uquota-state>off</uquota-state>\n          <gquota-state>off</gquota-state>\n          <pquota-state>off</pquota-state>\n          <target nil=\"true\"/>\n          <lun nil=\"true\"/>\n          <cache nil=\"true\"/>\n          <tenant-id type=\"integer\">11</tenant-id>\n          <has-mirror>NO</has-mirror>\n          <has-backup>NO</has-backup>\n          <is-remote-clone-source>NO</is-remote-clone-source>\n          <has-snapshots>NO</has-snapshots>\n          <shadow-copy-enabled>YES</shadow-copy-enabled>\n          <is-shadow-copy-clone>NO</is-shadow-copy-clone>\n          <read-iops-limit>0</read-iops-limit>\n          <read-mbps-limit>0</read-mbps-limit>\n          <write-iops-limit>0</write-iops-limit>\n          <write-mbps-limit>0</write-mbps-limit>\n          <read-iops-capping>0</read-iops-capping>\n          <read-mbps-capping>0</read-mbps-capping>\n          <write-iops-capping>0</write-iops-capping>\n          <write-mbps-capping>0</write-mbps-capping>\n          <compress>NO/Globally disabled</compress>\n          <dedupe>NO/Globally disabled</dedupe>\n          <mtr-histograms>NO</mtr-histograms>\n          <flc-state>FLC_NONE</flc-state>\n          <flc-scan-state>FLC_SCAN_NONE</flc-scan-state>\n          <flc-scan-progress type=\"float\">0.0</flc-scan-progress>\n          <flc-scan-remaining-time-seconds type=\"integer\">0</flc-scan-remaining-time-seconds>\n          <thresholds nil=\"true\"/>\n          <comment nil=\"true\"/>\n          <created-at>2021-09-09T16:31:51+0300</created-at>\n          <modified-at>2021-09-14T15:22:38+0300</modified-at>\n          <virtual-capacity type=\"integer\">500</virtual-capacity>\n          <flc-policy-name nil=\"true\"/>\n        </volume>\n    </volumes>\n</show-volumes-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000001\",\n        \"display_name\": \"smb1\",\n        \"cg_display_name\": \"smb1\",\n        \"cg_name\": \"cg-00000001\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"RAID-10-Pool-1\",\n        \"pool_name\": \"pool-00010001\",\n        \"pool_version\": 2,\n        \"status\": \"In-use\",\n        \"virtual_capacity\": 500,\n        \"server_name\": \"VM110\",\n        \"provisioned_capacity\": 500,\n        \"server_ext_names\": \"srv-00000001\",\n        \"life_cycle_policy_display_name\": null,\n        \"life_cycle_policy_ext_name\": null,\n        \"data_type\": \"File-System\",\n        \"thin\": \"NO\",\n        \"encryption\": \"NO\",\n        \"encryption_key_size\": \"0\",\n        \"total_capacity\": 499.51171875,\n        \"available_capacity\": 485.34765625,\n        \"num_of_filesystem_objects\": 13876,\n        \"capacity_mode\": \"normal\",\n        \"allocated_capacity\": 21.025390625,\n        \"data_copies_capacity\": 52.0400390625,\n        \"access_type\": \"SMB\",\n        \"read_only\": \"NO\",\n        \"nfs_export_path\": \"10.2.4.157:/export/smb1\",\n        \"smb_export_path\": \"\\\\\\\\10.2.4.157\\\\smb1\",\n        \"additional_smb_export_paths_count\": 0,\n        \"mount_sync\": \"YES\",\n        \"atime_update\": \"YES\",\n        \"read_ahead_kb\": 512,\n        \"ext_metering\": \"NO\",\n        \"images_repo\": \"NO\",\n        \"flc_db\": \"NO\",\n        \"audit_repo\": \"NO\",\n        \"nfs_root_squash\": \"NO\",\n        \"nfs_all_squash\": \"NO\",\n        \"nfs_anon_uid\": null,\n        \"nfs_anon_gid\": null,\n        \"smb_only\": \"NO\",\n        \"smb_guest\": \"NO\",\n        \"smb_windows_acl\": \"YES\",\n        \"smb_map_archive\": \"YES\",\n        \"smb_file_create_mask\": \"0744\",\n        \"smb_dir_create_mask\": \"0755\",\n        \"smb_aio_size\": 1,\n        \"smb_browseable\": \"YES\",\n        \"smb_hidden_files\": null,\n        \"smb_encryption_mode\": \"off\",\n        \"smb_case_sensitive\": \"AUTO\",\n        \"smb_mangled_names\": \"YES\",\n        \"smb_hide_unreadable\": \"NO\",\n        \"smb_hide_unwriteable\": \"NO\",\n        \"smb_hide_dot_files\": \"NO\",\n        \"smb_store_dos_attributes\": \"NO\",\n        \"smb_enable_oplocks\": \"YES\",\n        \"audit_enable\": \"YES\",\n        \"capacity_history\": 60,\n        \"alert_mode\": 360,\n        \"emergency_mode_mb\": 51200,\n        \"auto_expand_on_emergency\": \"NO\",\n        \"auto_expand_by\": 0,\n        \"max_capacity\": 102400,\n        \"uquota_state\": \"off\",\n        \"gquota_state\": \"off\",\n        \"pquota_state\": \"off\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"tenant_id\": 10,\n        \"has_mirror\": \"NO\",\n        \"has_backup\": \"NO\",\n        \"is_remote_clone_source\": \"NO\",\n        \"has_snapshots\": \"NO\",\n        \"shadow_copy_enabled\": \"YES\",\n        \"is_shadow_copy_clone\": \"NO\",\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"read_iops_capping\": \"0\",\n        \"read_mbps_capping\": \"0\",\n        \"write_iops_capping\": \"0\",\n        \"write_mbps_capping\": \"0\",\n        \"compress\": \"NO/Globally disabled\",\n        \"dedupe\": \"NO/Globally disabled\",\n        \"mtr_histograms\": \"NO\",\n        \"flc_state\": \"FLC_NONE\",\n        \"flc_scan_state\": \"FLC_SCAN_NONE\",\n        \"flc_scan_progress\": 0.0,\n        \"flc_scan_remaining_time_seconds\": 0,\n        \"thresholds\": null,\n        \"comment\": null,\n        \"created_at\": \"2021-09-09T16:31:28+0300\",\n        \"modified_at\": \"2021-09-14T14:49:53+0300\",\n        \"flc_policy_name\": null\n      },\n      {\n        \"name\": \"volume-00000002\",\n        \"display_name\": \"smb2\",\n        \"cg_display_name\": \"smb2\",\n        \"cg_name\": \"cg-00000002\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"RAID-10-Pool-1\",\n        \"pool_name\": \"pool-00010001\",\n        \"pool_version\": 2,\n        \"status\": \"In-use\",\n        \"provisioned_capacity\": 500,\n        \"server_name\": \"VM110\",\n        \"server_ext_names\": \"srv-00000001\",\n        \"life_cycle_policy_display_name\": null,\n        \"life_cycle_policy_ext_name\": null,\n        \"data_type\": \"File-System\",\n        \"thin\": \"NO\",\n        \"encryption\": \"NO\",\n        \"encryption_key_size\": \"0\",\n        \"total_capacity\": 499.51171875,\n        \"available_capacity\": 492.411132812,\n        \"num_of_filesystem_objects\": 6199,\n        \"capacity_mode\": \"normal\",\n        \"allocated_capacity\": 21.234375,\n        \"data_copies_capacity\": 61.953125,\n        \"access_type\": \"SMB\",\n        \"read_only\": \"NO\",\n        \"nfs_export_path\": \"10.2.4.157:/export/smb2\",\n        \"smb_export_path\": \"\\\\\\\\10.2.4.157\\\\smb2\",\n        \"additional_smb_export_paths_count\": 0,\n        \"mount_sync\": \"YES\",\n        \"atime_update\": \"YES\",\n        \"read_ahead_kb\": 512,\n        \"ext_metering\": \"NO\",\n        \"images_repo\": \"NO\",\n        \"flc_db\": \"NO\",\n        \"audit_repo\": \"NO\",\n        \"nfs_root_squash\": \"NO\",\n        \"nfs_all_squash\": \"NO\",\n        \"nfs_anon_uid\": null,\n        \"nfs_anon_gid\": null,\n        \"smb_only\": \"NO\",\n        \"smb_guest\": \"NO\",\n        \"smb_windows_acl\": \"YES\",\n        \"smb_map_archive\": \"YES\",\n        \"smb_file_create_mask\": \"0744\",\n        \"smb_dir_create_mask\": \"0755\",\n        \"smb_aio_size\": 1,\n        \"smb_browseable\": \"YES\",\n        \"smb_hidden_files\": null,\n        \"smb_encryption_mode\": \"off\",\n        \"smb_case_sensitive\": \"AUTO\",\n        \"smb_mangled_names\": \"YES\",\n        \"smb_hide_unreadable\": \"NO\",\n        \"smb_hide_unwriteable\": \"NO\",\n        \"smb_hide_dot_files\": \"NO\",\n        \"smb_store_dos_attributes\": \"NO\",\n        \"smb_enable_oplocks\": \"YES\",\n        \"audit_enable\": \"YES\",\n        \"capacity_history\": 60,\n        \"alert_mode\": 360,\n        \"emergency_mode_mb\": 51200,\n        \"auto_expand_on_emergency\": \"NO\",\n        \"auto_expand_by\": 0,\n        \"max_capacity\": 102400,\n        \"uquota_state\": \"off\",\n        \"gquota_state\": \"off\",\n        \"pquota_state\": \"off\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"tenant_id\": 11,\n        \"has_mirror\": \"NO\",\n        \"has_backup\": \"NO\",\n        \"is_remote_clone_source\": \"NO\",\n        \"has_snapshots\": \"NO\",\n        \"shadow_copy_enabled\": \"YES\",\n        \"is_shadow_copy_clone\": \"NO\",\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"read_iops_capping\": \"0\",\n        \"read_mbps_capping\": \"0\",\n        \"write_iops_capping\": \"0\",\n        \"write_mbps_capping\": \"0\",\n        \"compress\": \"NO/Globally disabled\",\n        \"dedupe\": \"NO/Globally disabled\",\n        \"mtr_histograms\": \"NO\",\n        \"flc_state\": \"FLC_NONE\",\n        \"flc_scan_state\": \"FLC_SCAN_NONE\",\n        \"flc_scan_progress\": 0.0,\n        \"flc_scan_remaining_time_seconds\": 0,\n        \"thresholds\": null,\n        \"comment\": null,\n        \"created_at\": \"2021-09-09T16:31:51+0300\",\n        \"modified_at\": \"2021-09-14T15:22:38+0300\",\n        \"virtual_capacity\": 500,\n        \"flc_policy_name\": null\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/volumes/{id}",
          "method": "GET",
          "description": "Show a single Volume details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-volume-response>\n    <status type=\"integer\">0</status>\n    <volume>\n        <name>volume-00000001</name>\n        <display-name>smb1</display-name>\n        <cg-display-name>smb1</cg-display-name>\n        <cg-name>cg-00000001</cg-name>\n        <cg-user-created>NO</cg-user-created>\n        <pool-display-name>RAID-10-Pool-1</pool-display-name>\n        <pool-name>pool-00010001</pool-name>\n        <pool-version type=\"integer\">2</pool-version>\n        <status>In-use</status>\n        <virtual-capacity type=\"integer\">500</virtual-capacity>\n        <server-name>VM110</server-name>\n        <provisioned-capacity type=\"integer\">500</provisioned-capacity>\n        <server-ext-names>srv-00000001</server-ext-names>\n        <life-cycle-policy-display-name nil=\"true\"/>\n        <life-cycle-policy-ext-name nil=\"true\"/>\n        <data-type>File-System</data-type>\n        <thin>NO</thin>\n        <encryption>NO</encryption>\n        <encryption-key-size>0</encryption-key-size>\n        <total-capacity type=\"float\">499.51171875</total-capacity>\n        <available-capacity type=\"float\">485.34765625</available-capacity>\n        <num-of-filesystem-objects type=\"integer\">13876</num-of-filesystem-objects>\n        <capacity-mode>normal</capacity-mode>\n        <allocated-capacity type=\"float\">21.025390625</allocated-capacity>\n        <data-copies-capacity type=\"float\">52.0400390625</data-copies-capacity>\n        <access-type>SMB</access-type>\n        <read-only>NO</read-only>\n        <nfs-export-path>10.2.4.157:/export/smb1</nfs-export-path>\n        <smb-export-path>\\\\10.2.4.157\\smb1</smb-export-path>\n        <additional-smb-export-paths-count type=\"integer\">0</additional-smb-export-paths-count>\n        <mount-sync>YES</mount-sync>\n        <atime-update>YES</atime-update>\n        <read-ahead-kb type=\"integer\">512</read-ahead-kb>\n        <ext-metering>NO</ext-metering>\n        <images-repo>NO</images-repo>\n        <flc-db>NO</flc-db>\n        <audit-repo>NO</audit-repo>\n        <nfs-root-squash>NO</nfs-root-squash>\n        <nfs-all-squash>NO</nfs-all-squash>\n        <nfs-anon-uid nil=\"true\"/>\n        <nfs-anon-gid nil=\"true\"/>\n        <smb-only>NO</smb-only>\n        <smb-guest>NO</smb-guest>\n        <smb-windows-acl>YES</smb-windows-acl>\n        <smb-map-archive>YES</smb-map-archive>\n        <smb-file-create-mask>0744</smb-file-create-mask>\n        <smb-dir-create-mask>0755</smb-dir-create-mask>\n        <smb-aio-size type=\"integer\">1</smb-aio-size>\n        <smb-browseable>YES</smb-browseable>\n        <smb-hidden-files nil=\"true\"/>\n        <smb-encryption-mode>off</smb-encryption-mode>\n        <smb-case-sensitive>AUTO</smb-case-sensitive>\n        <smb-mangled-names>YES</smb-mangled-names>\n        <smb-hide-unreadable>NO</smb-hide-unreadable>\n        <smb-hide-unwriteable>NO</smb-hide-unwriteable>\n        <smb-hide-dot-files>NO</smb-hide-dot-files>\n        <smb-store-dos-attributes>NO</smb-store-dos-attributes>\n        <smb-enable-oplocks>YES</smb-enable-oplocks>\n        <audit-enable>YES</audit-enable>\n        <capacity-history type=\"integer\">60</capacity-history>\n        <alert-mode type=\"integer\">360</alert-mode>\n        <emergency-mode-mb type=\"integer\">51200</emergency-mode-mb>\n        <auto-expand-on-emergency>NO</auto-expand-on-emergency>\n        <auto-expand-by type=\"integer\">0</auto-expand-by>\n        <max-capacity type=\"integer\">102400</max-capacity>\n        <uquota-state>off</uquota-state>\n        <gquota-state>off</gquota-state>\n        <pquota-state>off</pquota-state>\n        <target nil=\"true\"/>\n        <lun nil=\"true\"/>\n        <cache nil=\"true\"/>\n        <tenant-id type=\"integer\">10</tenant-id>\n        <has-mirror>NO</has-mirror>\n        <has-backup>NO</has-backup>\n        <is-remote-clone-source>NO</is-remote-clone-source>\n        <has-snapshots>NO</has-snapshots>\n        <shadow-copy-enabled>YES</shadow-copy-enabled>\n        <is-shadow-copy-clone>NO</is-shadow-copy-clone>\n        <read-iops-limit>0</read-iops-limit>\n        <read-mbps-limit>0</read-mbps-limit>\n        <write-iops-limit>0</write-iops-limit>\n        <write-mbps-limit>0</write-mbps-limit>\n        <read-iops-capping>0</read-iops-capping>\n        <read-mbps-capping>0</read-mbps-capping>\n        <write-iops-capping>0</write-iops-capping>\n        <write-mbps-capping>0</write-mbps-capping>\n        <compress>NO/Globally disabled</compress>\n        <dedupe>NO/Globally disabled</dedupe>\n        <mtr-histograms>NO</mtr-histograms>\n        <flc-state>FLC_NONE</flc-state>\n        <flc-scan-state>FLC_SCAN_NONE</flc-scan-state>\n        <flc-scan-progress type=\"float\">0.0</flc-scan-progress>\n        <flc-scan-remaining-time-seconds type=\"integer\">0</flc-scan-remaining-time-seconds>\n        <thresholds nil=\"true\"/>\n        <comment nil=\"true\"/>\n        <created-at>2021-09-09T16:31:28+0300</created-at>\n        <modified-at>2021-09-14T14:49:53+0300</modified-at>\n        <flc-policy-name nil=\"true\"/>\n    </volume>\n</show-one-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volume\": {\n      \"name\": \"volume-00000001\",\n      \"display_name\": \"smb1\",\n      \"cg_display_name\": \"smb1\",\n      \"cg_name\": \"cg-00000001\",\n      \"cg_user_created\": \"NO\",\n      \"pool_display_name\": \"RAID-10-Pool-1\",\n      \"pool_name\": \"pool-00010001\",\n      \"pool_version\": 2,\n      \"status\": \"In-use\",\n      \"virtual_capacity\": 500,\n      \"server_name\": \"VM110\",\n      \"provisioned_capacity\": 500,\n      \"server_ext_names\": \"srv-00000001\",\n      \"life_cycle_policy_display_name\": null,\n      \"life_cycle_policy_ext_name\": null,\n      \"data_type\": \"File-System\",\n      \"thin\": \"NO\",\n      \"encryption\": \"NO\",\n      \"encryption_key_size\": \"0\",\n      \"total_capacity\": 499.51171875,\n      \"available_capacity\": 485.34765625,\n      \"num_of_filesystem_objects\": 13876,\n      \"capacity_mode\": \"normal\",\n      \"allocated_capacity\": 21.025390625,\n      \"data_copies_capacity\": 52.0400390625,\n      \"access_type\": \"SMB\",\n      \"read_only\": \"NO\",\n      \"nfs_export_path\": \"10.2.4.157:/export/smb1\",\n      \"smb_export_path\": \"\\\\\\\\10.2.4.157\\\\smb1\",\n      \"additional_smb_export_paths_count\": 0,\n      \"mount_sync\": \"YES\",\n      \"atime_update\": \"YES\",\n      \"read_ahead_kb\": 512,\n      \"ext_metering\": \"NO\",\n      \"images_repo\": \"NO\",\n      \"flc_db\": \"NO\",\n      \"audit_repo\": \"NO\",\n      \"nfs_root_squash\": \"NO\",\n      \"nfs_all_squash\": \"NO\",\n      \"nfs_anon_uid\": null,\n      \"nfs_anon_gid\": null,\n      \"smb_only\": \"NO\",\n      \"smb_guest\": \"NO\",\n      \"smb_windows_acl\": \"YES\",\n      \"smb_map_archive\": \"YES\",\n      \"smb_file_create_mask\": \"0744\",\n      \"smb_dir_create_mask\": \"0755\",\n      \"smb_aio_size\": 1,\n      \"smb_browseable\": \"YES\",\n      \"smb_hidden_files\": null,\n      \"smb_encryption_mode\": \"off\",\n      \"smb_case_sensitive\": \"AUTO\",\n      \"smb_mangled_names\": \"YES\",\n      \"smb_hide_unreadable\": \"NO\",\n      \"smb_hide_unwriteable\": \"NO\",\n      \"smb_hide_dot_files\": \"NO\",\n      \"smb_store_dos_attributes\": \"NO\",\n      \"smb_enable_oplocks\": \"YES\",\n      \"audit_enable\": \"YES\",\n      \"capacity_history\": 60,\n      \"alert_mode\": 360,\n      \"emergency_mode_mb\": 51200,\n      \"auto_expand_on_emergency\": \"NO\",\n      \"auto_expand_by\": 0,\n      \"max_capacity\": 102400,\n      \"uquota_state\": \"off\",\n      \"gquota_state\": \"off\",\n      \"pquota_state\": \"off\",\n      \"target\": null,\n      \"lun\": null,\n      \"cache\": null,\n      \"tenant_id\": 10,\n      \"has_mirror\": \"NO\",\n      \"has_backup\": \"NO\",\n      \"is_remote_clone_source\": \"NO\",\n      \"has_snapshots\": \"NO\",\n      \"shadow_copy_enabled\": \"YES\",\n      \"is_shadow_copy_clone\": \"NO\",\n      \"read_iops_limit\": \"0\",\n      \"read_mbps_limit\": \"0\",\n      \"write_iops_limit\": \"0\",\n      \"write_mbps_limit\": \"0\",\n      \"read_iops_capping\": \"0\",\n      \"read_mbps_capping\": \"0\",\n      \"write_iops_capping\": \"0\",\n      \"write_mbps_capping\": \"0\",\n      \"compress\": \"NO/Globally disabled\",\n      \"dedupe\": \"NO/Globally disabled\",\n      \"mtr_histograms\": \"NO\",\n      \"flc_state\": \"FLC_NONE\",\n      \"flc_scan_state\": \"FLC_SCAN_NONE\",\n      \"flc_scan_progress\": 0.0,\n      \"flc_scan_remaining_time_seconds\": 0,\n      \"thresholds\": null,\n      \"comment\": null,\n      \"created_at\": \"2021-09-09T16:31:28+0300\",\n      \"modified_at\": \"2021-09-14T14:49:53+0300\",\n      \"flc_policy_name\": null\n    }\n  }\n}"
        },
        {
          "uri": "/volumes",
          "method": "POST",
          "description": "Create a Volume.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "required": true,
              "description": "The new volume name",
              "example": "my-volume"
            },
            {
              "name": "capacity",
              "type": "string",
              "example": "10G",
              "description": "Capacity in GB followed by the letter G.",
              "required": true
            },
            {
              "name": "block",
              "type": "string",
              "example": "YES",
              "options": "YES, NO",
              "description": "YES for a Block Volume, NO for a File Share."
            },
            {
              "name": "pool",
              "type": "string",
              "required": true,
              "example": "pool-00000001",
              "description": "The Pool ID to create the Volume/Share on."
            },
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "productType": "AFA",
              "example": "YES",
              "description": "Enable Dedupe For Volume. Default: YES."
            },
            {
              "name": "compress",
              "type": "string",
              "productType": "AFA",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable compress For Volume. Default: YES."
            },
            {
              "name": "crypt",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable encryption for this Volume."
            },
            {
              "name": "attachpolicies",
              "type": "string",
              "options": "YES, NO",
              "required": false,
              "description": "Attach default policies."
            },
            {
              "name": "mountsync",
              "type": "string",
              "options": "YES (Synchronous Writing), NO (Asynchronous Writing)",
              "example": "YES",
              "description": "Filesystem write policy."
            },
            {
              "name": "export_name",
              "type": "string",
              "description": "Export Name, required for a Share."
            },
            {
              "name": "atimeupdate",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable/disable atime updates for a Share."
            },
            {
              "name": "smbguest",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB guest access for a Share."
            },
            {
              "name": "smbonly",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB access only for a share."
            },
            {
              "name": "smbwindowsacl",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable/disabled enhanced Windows ACL for a Share."
            },
            {
              "name": "smbfilecreatemask",
              "type": "string",
              "description": "Set file creation permission for a Share."
            },
            {
              "name": "smbbrowseable",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB to be browseable."
            },
            {
              "name": "smbhiddenfiles",
              "type": "string",
              "description": "SMB files to hide."
            },
            {
              "name": "smbhideunreadable",
              "type": "string",
              "options": "YES, NO",
              "description": "hide/show SMB unreadable files."
            },
            {
              "name": "smbhideunwriteable",
              "type": "string",
              "options": "YES, NO"
            },
            {
              "name": "smbhidedotfiles",
              "type": "string",
              "options": "YES, NO",
              "description": "hide/show SMB unwriteable files."
            },
            {
              "name": "smbstoredosattributes",
              "type": "string",
              "options": "YES, NO",
              "description": "enable/disable SMB store dos attributes."
            },
            {
              "name": "smbdircreatemask",
              "type": "string",
              "description": "Set directory creation permission for a Share."
            },
            {
              "name": "smbmaparchive",
              "type": "string",
              "options": "YES, NO",
              "description": "Set map archive for smb Share."
            },
            {
              "name": "smbencryptionmode",
              "type": "string",
              "options": "off, desired, required",
              "description": "Set encryption mode for smb Share."
            },
            {
              "name": "smbenableoplocks",
              "type": "string",
              "options": "YES, NO",
              "description": "Set if smb oplocks enabled."
            },
            {
              "name": "smbmanglednames",
              "type": "string",
              "options": "YES, NO, ILLEGAL",
              "description": "Set mangling unsupported filenames handling."
            },
            {
              "name": "smbcasesensitive",
              "type": "string",
              "options": "YES, NO, AUTO",
              "description": "Set file names case sensitivity."
            },
            {
              "name": "nfsrootsquash",
              "type": "string",
              "options": "YES, NO",
              "description": "Set root squash for nfs mount"
            },
            {
              "name": "nfsallsquash",
              "type": "string",
              "options": "YES, NO",
              "description": "Set all squash for nfs mount"
            },
            {
              "name": "nfsanongid",
              "type": "integer",
              "description": "Set anonymous GID for nfs mount (0 is reserved for default)"
            },
            {
              "name": "nfsanonuid",
              "type": "integer",
              "description": "Set anonymous UID for nfs mount (0 is reserved for default)"
            },
            {
              "name": "readaheadkb",
              "type": "string",
              "options": "16, 64, 128, 256, 512",
              "description": "Set Read Ahead Value (KB)"
            },
            {
              "name": "autoexpand",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable capacity auto expand",
              "example": "YES"
            },
            {
              "name": "maxcapacity",
              "type": "string",
              "example": "300G",
              "description": "Max Capacity to expand in GB followed by the letter G."
            },
            {
              "name": "autoexpandby",
              "type": "string",
              "example": "300G",
              "description": "Capacity to expand by in GB followed by the letter G."
            },
            {
              "name": "auditenable",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable file access auditing on the volume."
            },
            {
              "name": "flcenabled",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable file lifecycle indexing on the volume."
            },
            {
              "name": "write_mbps_capping",
              "type": "integer",
              "example": 300,
              "description": "Block only."
            },
            {
              "name": "read_mbps_capping",
              "type": "integer",
              "example": 1300,
              "description": "Block only."
            },
            {
              "name": "write_iops_capping",
              "type": "integer",
              "description": "Block only.",
              "example": 2300
            },
            {
              "name": "read_iops_capping",
              "type": "integer",
              "example": 1500,
              "description": "Block only."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-volume-response>\n    <vol-name>volume-00000001</vol-name>\n    <status type=\"integer\">0</status>\n</create-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}",
          "method": "PUT",
          "description": "Update Volume's options.",
          "parameters": [
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable Dedupe For Volume."
            },
            {
              "name": "compress",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable compress For Volume."
            },
            {
              "name": "atimeupdate",
              "type": "string",
              "options": "YES, NO",
              "example": true,
              "description": "Enable/disable update access times."
            },
            {
              "name": "mountsync",
              "type": "string",
              "options": "YES (Synchronous Writing), NO (Asynchronous Writing)",
              "example": "YES",
              "description": "Filesystem write policy."
            },
            {
              "name": "smbguest",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB guest access for a Share."
            },
            {
              "name": "smbonly",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB access only for a share."
            },
            {
              "name": "smbwindowsacl",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable/disabled enhanced Windows ACL for a Share."
            },
            {
              "name": "smbfilecreatemask",
              "type": "string",
              "description": "Updates file creation permission for a Share."
            },
            {
              "name": "smbdircreatemask",
              "type": "string",
              "example": "0600",
              "description": "Updates directory creation permission for a Share."
            },
            {
              "name": "smbbrowseable",
              "type": "string",
              "options": "YES, NO",
              "description": "Allow/disallow SMB to be browseable."
            },
            {
              "name": "smbhiddenfiles",
              "type": "string",
              "description": "SMB files to hide."
            },
            {
              "name": "smbhideunreadable",
              "type": "string",
              "options": "YES, NO",
              "description": "hide/show SMB unreadable files."
            },
            {
              "name": "smbhidedotfiles",
              "type": "string",
              "options": "YES, NO",
              "description": "hide/show SMB dot files."
            },
            {
              "name": "smbhideunwriteable",
              "type": "string",
              "options": "YES, NO",
              "description": "hide/show SMB unwriteable files."
            },
            {
              "name": "smbmaparchive",
              "type": "string",
              "options": "YES, NO",
              "example": false,
              "description": "Allow/disallow map archive for smb Share."
            },
            {
              "name": "smbencryptionmode",
              "type": "string",
              "options": "off, desired, required",
              "description": "Set encryption mode for smb Share."
            },
            {
              "name": "smbenableoplocks",
              "type": "string",
              "options": "YES, NO",
              "description": "Set if smb oplocks enabled."
            },
            {
              "name": "smbmanglednames",
              "type": "string",
              "options": "YES, NO, ILLEGAL",
              "description": "Set mangling unsupported filenames handling."
            },
            {
              "name": "smbcasesensitive",
              "type": "string",
              "options": "YES, NO, AUTO",
              "description": "Set file names case sensitivity."
            },
            {
              "name": "nfsrootsquash",
              "type": "string",
              "options": "YES, NO",
              "description": "Set root squash for nfs mount"
            },
            {
              "name": "nfsallsquash",
              "type": "string",
              "options": "YES, NO",
              "description": "Set all squash for nfs mount"
            },
            {
              "name": "nfsanongid",
              "type": "integer",
              "description": "Set anonymous GID for nfs mount (0 is reserved for default)"
            },
            {
              "name": "nfsanonuid",
              "type": "integer",
              "description": "Set anonymous UID for nfs mount (0 is reserved for default)"
            },
            {
              "name": "readaheadkb",
              "type": "string",
              "options": "16, 64, 128, 256, 512",
              "description": "Update Read Ahead Value (KB)"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Update volume parameters even if volume is attached to a server. Default: NO:"
            },
            {
              "name": "auditenable",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable file access auditing on the volume."
            },
            {
              "name": "flcenabled",
              "type": "string",
              "options": "enable, disable, resume, pause",
              "example": "enable",
              "description": "Required FLC indexing state."
            },
            {
              "name": "mtr_histograms",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Configure IO distribution by size analysis on the volume."
            },
            {
              "name": "write_mbps_capping",
              "type": "integer",
              "example": 300,
              "description": "Block only."
            },
            {
              "name": "read_mbps_capping",
              "type": "integer",
              "example": 1300,
              "description": "Block only."
            },
            {
              "name": "write_iops_capping",
              "type": "integer",
              "example": 2300,
              "description": "Block only."
            },
            {
              "name": "read_iops_capping",
              "type": "integer",
              "example": 1500,
              "description": "Block only."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-volume-nas-options-response>\n    <vol-name>volume-00000002</vol-name>\n    <status type=\"integer\">0</status>\n</set-volume-nas-options-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}",
          "method": "DELETE",
          "description": "Delete a Volume.",
          "parameters": [
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Delete the volume even if snapshots exist. Default: NO:"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-volume-response>\n    <vol-name>volume-00000001</vol-name>\n    <status type=\"integer\">0</status>\n</delete-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/free",
          "method": "GET",
          "description": "Show all Volumes which are not attached to any Server.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-volumes-free-response>\n    <status type=\"integer\">0</status>\n    <volumes-count type=\"integer\">2</volumes-count>\n    <volumes type=\"array\">\n        <volume>\n            <name>volume-00000001</name>\n            <display-name>volume</display-name>\n            <cg-display-name>volume</cg-display-name>\n            <cg-name>cg-00000001</cg-name>\n            <cg-user-created>NO</cg-user-created>\n            <pool-display-name>poolrenamed</pool-display-name>\n            <pool-name>pool-00000001</pool-name>\n            <status>Available</status>\n            <virtual-capacity type=\"integer\">200</virtual-capacity>\n            <server-name />\n            <data-type>BLOCK</data-type>\n            <thin>YES</thin>\n            <encryption>NO</encryption>\n            <access-type />\n            <read-only />\n            <export-name />\n            <mount-sync>NO</mount-sync>\n            <atime-update>NO</atime-update>\n            <target />\n            <lun />\n            <cache />\n            <read-iops-limit>0</read-iops-limit>\n            <read-mbps-limit>0</read-mbps-limit>\n            <write-iops-limit>0</write-iops-limit>\n            <write-mbps-limit>0</write-mbps-limit>\n            <created-at type=\"datetime\">2013-09-26 00:42:30</created-at>\n            <modified-at type=\"datetime\">2013-09-26 00:42:31</modified-at>\n        </volume>\n        <volume>\n            <name>volume-00000002</name>\n            <display-name>share</display-name>\n            <cg-display-name>share</cg-display-name>\n            <cg-name>cg-00000002</cg-name>\n            <cg-user-created>NO</cg-user-created>\n            <pool-display-name>poolrenamed</pool-display-name>\n            <pool-name>pool-00000001</pool-name>\n            <status>Available</status>\n            <virtual-capacity type=\"integer\">200</virtual-capacity>\n            <server-name />\n            <data-type>File-System</data-type>\n            <thin>NO</thin>\n            <encryption>NO</encryption>\n            <access-type />\n            <read-only />\n            <export-name>/export/share</export-name>\n            <mount-sync>NO</mount-sync>\n            <atime-update>NO</atime-update>\n            <target />\n            <lun />\n            <cache />\n            <read-iops-limit>0</read-iops-limit>\n            <read-mbps-limit>0</read-mbps-limit>\n            <write-iops-limit>0</write-iops-limit>\n            <write-mbps-limit>0</write-mbps-limit>\n            <created-at type=\"datetime\">2013-09-26 00:52:00</created-at>\n            <modified-at type=\"datetime\">2013-09-27 00:21:28</modified-at>\n        </volume>\n    </volumes>\n</show-volumes-free-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000001\",\n        \"display_name\": \"volume\",\n        \"cg_display_name\": \"volume\",\n        \"cg_name\": \"cg-00000001\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"poolrenamed\",\n        \"pool_name\": \"pool-00000001\",\n        \"status\": \"Available\",\n        \"virtual_capacity\": 200,\n        \"server_name\": null,\n        \"data_type\": \"BLOCK\",\n        \"thin\": \"YES\",\n        \"encryption\": \"NO\",\n        \"access_type\": null,\n        \"read_only\": null,\n        \"export_name\": null,\n        \"mount_sync\": \"NO\",\n        \"atime_update\": \"NO\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"created_at\": \"2013-09-26 00:42:30 UTC\",\n        \"modified_at\": \"2013-09-26 00:42:31 UTC\"\n      },\n      {\n        \"name\": \"volume-00000002\",\n        \"display_name\": \"share\",\n        \"cg_display_name\": \"share\",\n        \"cg_name\": \"cg-00000002\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"poolrenamed\",\n        \"pool_name\": \"pool-00000001\",\n        \"status\": \"Available\",\n        \"virtual_capacity\": 200,\n        \"server_name\": null,\n        \"data_type\": \"File-System\",\n        \"thin\": \"NO\",\n        \"encryption\": \"NO\",\n        \"access_type\": null,\n        \"read_only\": null,\n        \"export_name\": \"/export/share\",\n        \"mount_sync\": \"NO\",\n        \"atime_update\": \"NO\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"created_at\": \"2013-09-26 00:52:00 UTC\",\n        \"modified_at\": \"2013-09-27 00:21:28 UTC\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/rename",
          "method": "POST",
          "description": "Rename a Volume.",
          "parameters": [
            {
              "name": "new_name",
              "type": "string"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-volume-response>\n    <vol-name>volume-00000002</vol-name>\n    <status type=\"integer\">0</status>\n</rename-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/expand",
          "method": "POST",
          "description": "Expand a Volume.",
          "parameters": [
            {
              "name": "capacity",
              "type": "string",
              "required": true,
              "description": "Capacity in GB followed by the letter G.",
              "example": "30G"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<expand-volume-response>\n    <vol-name>volume-00000001</vol-name>\n    <status type=\"integer\">0</status>\n</expand-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/servers",
          "method": "GET",
          "description": "Show the Servers to which the Volume is attached",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-servers-response>\n    <status type=\"integer\">0</status>\n    <servers-count type=\"integer\">1</servers-count>\n    <servers type=\"array\">\n        <server>\n            <name>srv-00000001</name>\n            <display-name>server</display-name>\n            <iqn>127.0.0.1</iqn>\n            <iscsi-ip>127.0.0.1</iscsi-ip>\n            <ipsec>1</ipsec>\n            <status>Active</status>\n            <os />\n            <registered>no</registered>\n            <created-at type=\"datetime\">2013-09-26 11:51:40</created-at>\n            <modified-at type=\"datetime\">2013-09-27 00:38:43</modified-at>\n            <pm-status>In-use</pm-status>\n            <target>iqn.2011-04.com.zadarastorage:vsa-000007bb:1</target>\n            <access-type>ISCSI</access-type>\n            <read-only>NO</read-only>\n            <lun>0</lun>\n        </server>\n    </servers>\n</show-servers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"servers\": [\n      {\n        \"name\": \"srv-00000001\",\n        \"display_name\": \"server\",\n        \"iqn\": \"127.0.0.1\",\n        \"iscsi_ip\": \"127.0.0.1\",\n        \"ipsec\": \"1\",\n        \"status\": \"Active\",\n        \"os\": null,\n        \"registered\": \"no\",\n        \"created_at\": \"2013-09-26 11:51:40 UTC\",\n        \"modified_at\": \"2013-09-27 00:38:43 UTC\",\n        \"pm_status\": \"In-use\",\n        \"target\": \"iqn.2011-04.com.zadarastorage:vsa-000007bb:1\",\n        \"access_type\": \"ISCSI\",\n        \"read_only\": \"NO\",\n        \"lun\": \"0\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/detach",
          "method": "POST",
          "description": "Detach a Volume from one or more servers",
          "parameters": [
            {
              "name": "servers",
              "type": "string",
              "required": true,
              "description": "Comma-separated list of Server IDs.",
              "example": "srv-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<detach-volume-response>\n    <status type=\"integer\">0</status>\n</detach-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/export_name",
          "method": "PUT",
          "description": "Change a Share's export name.",
          "parameters": [
            {
              "name": "exportname",
              "description": "The new export name for the Share.",
              "required": true,
              "type": "string",
              "example": "new-export-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-volume-export-name-response>\n    <vol-name>volume-00000003</vol-name>\n    <status type=\"integer\">0</status>\n</update-volume-export-name-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/add_export_name",
          "method": "PUT",
          "description": "Add a secondary export name to Share.",
          "parameters": [
            {
              "name": "exportname",
              "description": "The new secondary export name for the Share.",
              "required": true,
              "type": "string",
              "example": "secondary-export-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add-volume-export-name-response>\n    <vol-name>volume-00000003</vol-name>\n    <status type=\"integer\">0</status>\n</add-volume-export-name-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/export_name",
          "method": "DELETE",
          "description": "Delete a secondary export name from Share.",
          "parameters": [
            {
              "name": "exportname",
              "description": "The export name to delete.",
              "required": true,
              "type": "string",
              "example": "secondary-export-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<remove-volume-export-name-response>\n    <vol-name>volume-00000003</vol-name>\n    <status type=\"integer\">0</status>\n</remove-volume-export-name-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/delete_volume_from_recycle_bin",
          "method": "DELETE",
          "description": "Deletes a volume(s) from recycle bin",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-volume-from-recycle-bin>\n    <status type=\"integer\">0</status>\n    <volname>volume-00000034</volname>\n</delete-volume-from-recycle-bin>\n",
          "response_json": "{\n  \"delete_volume_from_recycle_bin\": {\n    \"status\": 0,\n    \"volname\": \"volume-00000034\"\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/export_name",
          "method": "PUT",
          "description": "Change a Share's export name.",
          "parameters": [
            {
              "name": "exportname",
              "description": "The new export name for the Share.",
              "required": true,
              "type": "string",
              "example": "share-export-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-volume-export-name-response>\n    <vol-name>volume-00000003</vol-name>\n    <status type=\"integer\">0</status>\n</update-volume-export-name-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/snapshot_policies",
          "method": "GET",
          "description": "Get the Snapshot Policies attached to a Volume.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-snapshot-policies-on-cg-response>\n    <status type=\"integer\">0</status>\n    <snapshot-policies-count type=\"integer\">1</snapshot-policies-count>\n    <snapshot-policies type=\"array\">\n        <snapshot-policy>\n            <name>policy-00000002</name>\n            <display-name>Hourly Snapshots for a Day</display-name>\n            <create-policy>0 * * * *</create-policy>\n            <delete-policy>N24</delete-policy>\n            <destination-delete-policy>N24</destination-delete-policy>\n            <paused>NO</paused>\n            <create-empty>NO</create-empty>\n            <attach>NO</attach>\n            <destination>NO</destination>\n            <type></type>\n            <snapshot-rule>rule-000000d6</snapshot-rule>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </snapshot-policy>\n    </snapshot-policies>\n</show-snapshot-policies-on-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshot_policies\": [\n      {\n        \"name\": \"policy-00000002\",\n        \"display_name\": \"Hourly Snapshots for a Day\",\n        \"create_policy\": \"0 * * * *\",\n        \"delete_policy\": \"N24\",\n        \"destination_delete_policy\": \"N24\",\n        \"paused\": \"NO\",\n        \"create_empty\": \"NO\",\n        \"attach\": \"NO\",\n        \"destination\": \"NO\",\n        \"type\": null,\n        \"snapshot_rule\": \"rule-000000d6\",\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/file_history",
          "method": "GET",
          "description": "Get the volume file history.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <count type=\"integer\">5</count>\n  <file-histories type=\"array\">\n    <file-history>\n      <name>volume-0000000e</name>\n      <display-name>h-r8-1459428261852</display-name>\n      <status>normal</status>\n      <created-at>2016-03-31T15:44:21+0300</created-at>\n      <pool-display-name>pool1</pool-display-name>\n      <pool-name>pool-00000001</pool-name>\n    </file-history>\n  </file-histories>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"file_histories\": [\n      {\n        \"name\": \"volume-0000000e\",\n        \"display_name\": \"h-r8-1459428261852\",\n        \"status\": \"normal\",\n        \"created_at\": \"2016-03-31T15:44:21+0300\",\n        \"pool_display_name\": \"pool1\",\n        \"pool_name\": \"pool-00000001\"\n      }\n    ],\n    \"count\": 5\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/attach_snapshot_policy",
          "method": "POST",
          "description": "Attach a Snapshot Policy to a Volume.",
          "parameters": [
            {
              "name": "id",
              "type": "string",
              "description": "A volume ID.",
              "required": true
            },
            {
              "name": "policy",
              "type": "string",
              "description": "A policy ID.",
              "required": true,
              "example": "policy-00000001"
            },
            {
              "name": "application",
              "type": "string",
              "description": "Policy Application.",
              "options": "user|file_history",
              "required": true,
              "example": "user"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<attach-snapshot-policy-response>\n    <snapshot-rule-name>snaprule-00000003</snapshot-rule-name>\n    <status type=\"integer\">0</status>\n</attach-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_rule_name\": \"snaprule-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/detach_snapshot_policy",
          "method": "POST",
          "description": "Detach a Snapshot Policy from a Volume.",
          "parameters": [
            {
              "name": "id",
              "type": "string",
              "description": "A volume ID.",
              "required": true,
              "example": "volume-00000001"
            },
            {
              "name": "snaprule",
              "type": "string",
              "description": "A snap rule ID. (found in /consistency_groups/{volume_cg_id}/snapshot_policies API)",
              "required": true,
              "example": "snaprule-00000001"
            },
            {
              "name": "delete_snapshots",
              "type": "string",
              "description": "Delete Snapshots associated with the Policy.",
              "options": "YES, NO"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Force Detach a Snapshot Policy from a Volume."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<detach-snapshot-policy-response>\n    <snapshot-rule-name>snaprule-00000003</snapshot-rule-name>\n    <status type=\"integer\">0</status>\n</detach-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_rule_name\": \"snaprule-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{snaprule}/pause",
          "method": "POST",
          "description": "Pause a volume's snapshot policy.",
          "parameters": [
            {
              "name": "id",
              "type": "string",
              "description": "A snap rule ID. (found in /consistency_groups/{volume_cg_id}/snapshot_policies API)",
              "required": true,
              "example": "snaprule-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-snapshot-policy-response>\n    <snaprule-name>snaprule-00000003</snaprule-name>\n    <status type=\"integer\">0</status>\n</pause-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snaprule_name\": \"snaprule-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/snapshots",
          "method": "GET",
          "description": "Get the list of Snapshots for this Volume.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            },
            {
              "name": "application",
              "type": "string",
              "description": "Policy Application.",
              "options": "user|mirror|migration|obs_mirror|shadow_copy",
              "example": "mirror"
            },
            {
              "name": "jobname",
              "type": "string",
              "description": "Mirror Job used to create the snapshots.",
              "example": "srcjvpsa-00000002"
            },
            {
              "name": "snapshot_policy",
              "type": "string",
              "description": "Snapshot Policy which created the snapshots.",
              "example": "policy-00000002"
            },
            {
              "name": "start_date",
              "type": "string",
              "description": "Snapshots created after the provided value (DD:MM:YY:HH:MM:SS localtime)",
              "example": "05:02:17:13:44:55"
            },
            {
              "name": "end_date",
              "type": "string",
              "description": "Snapshots created before the provided value DD:MM:YY:HH:MM:SS localtime)",
              "example": "05:02:17:14:44:55"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-snapshots-on-cg-response>\n    <status type=\"integer\">0</status>\n    <snapshots-count type=\"integer\">1</snapshots-count>\n    <snapshots type=\"array\">\n        <snapshot>\n            <name>snap-00000001</name>\n            <display-name>s-r2-1380150028000</display-name>\n            <status>normal</status>\n            <cg-display-name>volume</cg-display-name>\n            <cg-name>cg-00000001</cg-name>\n            <pool-name>pool-00000001</pool-name>\n            <created-at type=\"datetime\">2013-09-26 01:00:28</created-at>\n            <modified-at type=\"datetime\">2013-09-26 01:00:28</modified-at>\n            <volume-ext-name>volume-00000001</volume-ext-name>\n            <volume-display-name>v1</volume-display-name>\n            <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n        </snapshot>\n    </snapshots>\n</show-snapshots-on-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshots\": [\n      {\n        \"name\": \"snap-00000001\",\n        \"display_name\": \"s-r2-1380150028000\",\n        \"status\": \"normal\",\n        \"cg_display_name\": \"volume\",\n        \"cg_name\": \"cg-00000001\",\n        \"pool_name\": \"pool-00000001\",\n        \"created_at\": \"2013-09-26 01:00:28 UTC\",\n        \"modified_at\": \"2013-09-26 01:00:28 UTC\",\n        \"volume_ext_name\": \"volume-00000001\",\n        \"volume_display_name\": \"v1\",\n        \"volume_capacity_mb\": 102400\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/snapshots",
          "method": "POST",
          "description": "Create a Snapshot of a Volume.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "example": "end-of-week-snapshot",
              "description": "The new snapshot name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-snapshot-response>\n    <snapshot-name>snap-00000002</snapshot-name>\n    <status type=\"integer\">0</status>\n</create-snapshot-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_name\": \"snap-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshots/{snapshot_id}",
          "method": "DELETE",
          "description": "Delete a Snapshot of a Volume.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-snapshot-response>\n    <snapshot-name>snap-00000002</snapshot-name>\n    <status type=\"integer\">0</status>\n</delete-snapshot-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_name\": \"snap-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/file_histories/{volume_id}",
          "method": "DELETE",
          "description": "Delete the file history of a Volume.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <vol_name>volume-00000002</vol_name>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{migration_cg_id}/show_migration",
          "method": "GET",
          "description": "Shows a migration job",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-cg-migration-job-response>\n  <status type=\"integer\">0</status>\n  <migration-job>\n    <name>mgrjob-00000003</name>\n    <display-name>vol-example</display-name>\n    <src-cg-display-name>vol-iscsi</src-cg-display-name>\n    <src-cg-name>cg-00000005</src-cg-name>\n    <src-pool-display-name>pool1</src-pool-display-name>\n    <dst-cg-name>cg-00000006</dst-cg-name>\n    <dst-pool-display-name>pool1</dst-pool-display-name>\n    <shipping-display-name>...</shipping-display-name>\n    <status>Paused</status>\n    <cur-sync-rate-kb-sec type=\"integer\">0</cur-sync-rate-kb-sec>\n    <shipping-position-mb type=\"integer\">0</shipping-position-mb>\n    <total-capacity-to-migrate-mb type=\"integer\">1000</total-capacity-to-migrate-mb>\n    <already-migrated-mb type=\"integer\">500</already-migrated-mb>\n    <remaining-time-seconds type=\"integer\"></remaining-time-seconds>\n    <created-at type=\"datetime\">2014-01-01 11:41:29</created-at>\n    <modified-at type=\"datetime\">2014-01-01 11:41:55</modified-at>\n  </migration-job>\n</show-cg-migration-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"migration_job\": {\n      \"name\": \"mgrjob-00000003\",\n      \"display_name\": \"vol-example\",\n      \"src_cg_display_name\": \"vol-iscsi\",\n      \"src_cg_name\": \"cg-00000005\",\n      \"src_pool_display_name\": \"pool1\",\n      \"dst_cg_name\": \"cg-00000006\",\n      \"dst_pool_display_name\": \"pool1\",\n      \"shipping_display_name\": \"...\",\n      \"status\": \"Paused\",\n      \"cur_sync_rate_kb_sec\": 0,\n      \"shipping_position_mb\": 0,\n      \"total_capacity_to_migrate_mb\": 1000,\n      \"already_migrated_mb\": 500,\n      \"remaining_time_seconds\": null,\n      \"created_at\": \"2014-01-01 11:41:29 UTC\",\n      \"modified_at\": \"2014-01-01 11:41:55 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/migrate",
          "method": "POST",
          "description": "Migrate a volume to a different pool",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n  <create-migration-job-response>\n    <migration-job-name>mgrjob-00000001</migration-job-name>\n    <status type=\"integer\">0</status>\n  </create-migration-job-response>\n",
          "parameters": [
            {
              "name": "poolname",
              "type": "string",
              "required": true,
              "description": "Pool id of migrated volume.",
              "example": "volume1-clone"
            },
            {
              "name": "migratesnap",
              "type": "string",
              "options": "YES, NO",
              "description": "Migrate snapshots"
            }
          ],
          "response_json": "{\n  \"response\": {\n    \"migration_job_name\": \"mgrjob-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/migration_jobs/{migration_cg_id}/pause",
          "method": "POST",
          "description": "Pause a migration job",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-migration-job-response>\n  <cg-name>cg-00000005</cg-name>\n  <status type=\"integer\">0</status>\n</pause-migration-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"cg_name\": \"cg-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/migration_jobs/{migration_cg_id}/continue",
          "method": "POST",
          "description": "Continue a migration job",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<continue-migration-job-response>\n  <cg-name>cg-00000005</cg-name>\n  <status type=\"integer\">0</status>\n</continue-migration-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"cg_name\": \"cg-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/migration_jobs/{migration_cg_id}/abort",
          "method": "POST",
          "description": "Abort a migration job",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<abort-migration-job-response>\n  <cg-name>cg-00000005</cg-name>\n  <status type=\"integer\">0</status>\n</abort-migration-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"cg_name\": \"cg-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/clone",
          "method": "POST",
          "description": "Clones a Volume. If a snapshot ID is provided the new cloned Volume will have the data set of that Snapshot. Otherwise, the dataset of the Volume at the moment the Clone is created",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "required": true,
              "description": "The name for the new Cloned volume.",
              "example": "volume1-clone"
            },
            {
              "name": "snapshot",
              "type": "string",
              "description": "An optional Snapshot ID.",
              "example": "snap-00000002"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<clone-cg-response>\n    <cg-name>cg-00000003</cg-name>\n    <status type=\"integer\">0</status>\n</clone-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"cg_name\": \"cg-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{volume_cg_id}/mirror",
          "method": "POST",
          "description": "Create a new Asynchronous snapshot-based Remote Mirror relationship with a remote VPSA for this Volume",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "description": "The name for the Mirror Job.",
              "example": "new-mirror"
            },
            {
              "name": "remote_pool",
              "description": "Pool ID on the remote VPSA where the Mirrored Volume will be created",
              "type": "string",
              "required": true,
              "example": "pool-00000001"
            },
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable Dedupe For Mirror."
            },
            {
              "name": "compress",
              "type": "string",
              "options": "YES, NO",
              "productType": "AFA",
              "example": "YES",
              "description": "Enable compress For Mirror."
            },
            {
              "name": "policy",
              "type": "string",
              "description": "Snapshot Policy ID for Remote Mirroring.",
              "required": true,
              "example": [
                "policy-00000001",
                "policy-00000002"
              ]
            },
            {
              "name": "new_cg_name",
              "description": "Name for the mirrored Volume on the Remote VPSA.",
              "required": true,
              "type": "string",
              "example": "mirrored-volume"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-vpsa-mirror-job-response>\n    <vpsa-mirror-job-name>srcjvpsa-00000001</vpsa-mirror-job-name>\n    <status type=\"integer\">0</status>\n</create-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quotas",
          "method": "GET",
          "extension": "json",
          "no_header_extension": true,
          "description": "fetch volume quotas.",
          "parameters": [
            {
              "name": "scope",
              "type": "string",
              "required": true,
              "description": "quota's type (user or group)",
              "example": "user",
              "options": "user | group | project"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <quotas type=\"array\">\n    <quota>\n      <source-id>25</source-id>\n      <source-id-display>test1</source-id-display>\n      <usage>14</usage>\n      <soft>0</soft>\n      <hard>14</hard>\n      <source-type>project</source-type>\n      <nas-type>0</nas-type>\n    </quota>\n    <quota>\n      <source-id>26</source-id>\n      <source-id-display>test77</source-id-display>\n      <usage>0</usage>\n      <soft>0</soft>\n      <hard>18</hard>\n      <source-type>project</source-type>\n      <nas-type>0</nas-type>\n    </quota>\n  </quotas>\n  <count type=\"integer\">2</count>\n  <updated>1 day</updated>\n  <updated-iso type=\"dateTime\">2017-04-23T13:42:40+03:00</updated-iso>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"quotas\": [\n      {\n        \"source_id\": \"25\",\n        \"source_id_display\": \"test1\",\n        \"usage\": \"14\",\n        \"soft\": \"0\",\n        \"hard\": \"14\",\n        \"source_type\": \"project\",\n        \"nas_type\": \"0\"\n      },\n      {\n        \"source_id\": \"26\",\n        \"source_id_display\": \"test77\",\n        \"usage\": \"0\",\n        \"soft\": \"0\",\n        \"hard\": \"18\",\n        \"source_type\": \"project\",\n        \"nas_type\": \"0\"\n      }\n    ],\n    \"updated\": \"1 day\",\n    \"updated_iso\": \"2017-04-23 10:42:40 UTC\",\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quotas",
          "method": "POST",
          "description": "Add volume quotas",
          "parameters": [
            {
              "name": "quotas",
              "type": "Array",
              "required": true,
              "description": "Array of quota properties",
              "example_as_json_string": true,
              "example": "[{\"source_id\":44, \"source_type\":\"group\", \"nas_type\":\"uid\", \"limit\":88}]"
            },
            {
              "name": "source_id",
              "type": "integer",
              "isSub": true,
              "required": true,
              "description": "source (group/user/project) id"
            },
            {
              "name": "source_type",
              "type": "string",
              "isSub": true,
              "required": true,
              "options": "user | group | project"
            },
            {
              "name": "nas_type",
              "type": "string",
              "isSub": true,
              "required": true,
              "options": "ad | uid | nas",
              "description": "use any value for project"
            },
            {
              "name": "limit",
              "type": "string",
              "isSub": true,
              "description": "quota limit (MB)",
              "required": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <errors></errors>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"errors\": null,\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quotas_state",
          "method": "POST",
          "description": "Update quotas state (at least one of uquota/gquota/pquota required)",
          "parameters": [
            {
              "name": "uquota",
              "type": "string",
              "description": "set user quota state",
              "options": "on | off",
              "example": "off"
            },
            {
              "name": "gquota",
              "type": "string",
              "description": "set group quota state",
              "example": "on",
              "options": "on | off"
            },
            {
              "name": "pquota",
              "type": "string",
              "description": "set group quota state",
              "example": "on",
              "options": "on | off"
            },
            {
              "name": "force",
              "description": "Force quota state change (skip warnings)",
              "type": "string",
              "options": "YES | NO"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <vol-name>volume-00000001</vol-name>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota",
          "method": "GET",
          "description": "Get one volume quota",
          "parameters": [
            {
              "name": "scope",
              "type": "string",
              "required": true,
              "description": "quota's type",
              "example": "user",
              "options": "user | group | project"
            },
            {
              "name": "quota_id",
              "description": "NFS id / Project Id",
              "type": "Integer",
              "example": 100
            },
            {
              "name": "quota_nas",
              "description": "NAS name",
              "type": "String",
              "example": 100
            },
            {
              "name": "quota_ad",
              "description": "Active directry name",
              "type": "String",
              "example": 100
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <value type=\"integer\">0</value>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"value\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/import_quotas",
          "method": "POST",
          "file_upload": true,
          "no_extension": true,
          "no_content_type": true,
          "description": "Import volume quotas",
          "parameters": [
            {
              "name": "scope",
              "type": "string",
              "required": true,
              "description": "quota's type (user or group)",
              "example": "user"
            },
            {
              "name": "file_format",
              "description": "Input file format",
              "type": "string",
              "required": true,
              "example": "csv",
              "options": "csv | text"
            },
            {
              "name": "file",
              "description": "Input file",
              "type": "file",
              "required": true,
              "example": "@/tmp/import.csv"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota_projects",
          "method": "GET",
          "description": "Get quota projects",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-quota-projects-response>\n  <status type=\"integer\">0</status>\n  <projects-count type=\"integer\">1</projects-count>\n  <projects type=\"array\">\n    <project>\n      <name>project-00000001</name>\n      <display-name>test1</display-name>\n      <id>1</id>\n      <volume-id type=\"integer\">1</volume-id>\n      <was-deleted type=\"integer\">False</was-deleted>\n      <created-at type=\"datetime\">2017-04-06T15:05:19+0300</created-at>\n      <modified-at type=\"datetime\">2017-04-06T15:05:19+0300</modified-at>\n      <directories-count type=\"integer\">1</directories-count>\n      <directories type=\"array\">\n        <directory>\n          <path>testdir</path>\n        </directory>\n      </directories>\n    </project>\n  </projects>\n</show-quota-projects-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"projects\": [\n      {\n        \"name\": \"project-00000001\",\n        \"display_name\": \"test1\",\n        \"id\": \"1\",\n        \"volume_id\": 1,\n        \"was_deleted\": 0,\n        \"created_at\": \"2017-04-06 12:05:19 UTC\",\n        \"modified_at\": \"2017-04-06 12:05:19 UTC\",\n        \"directories_count\": 1,\n        \"directories\": [\n          {\n            \"path\": \"testdir\"\n          }\n        ]\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota_projects",
          "method": "POST",
          "description": "Create a quota project",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "example": "proj1"
            },
            {
              "name": "directories",
              "type": "Array",
              "description": "Array of directories",
              "example_as_json_string": true,
              "example": "[\"dir1\", \"dir2\"]"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <errors></errors>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"errors\": null\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota_projects",
          "method": "DELETE",
          "description": "Delete a quota project",
          "parameters": [
            {
              "name": "project_id",
              "type": "string",
              "example": "proj-00000001"
            },
            {
              "name": "force",
              "description": "Force delete if project has directories",
              "type": "string",
              "options": "YES | NO"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota_project_directories",
          "method": "POST",
          "description": "Add directories to Quota Project",
          "parameters": [
            {
              "name": "project_id",
              "type": "string",
              "example": "proj-00000001"
            },
            {
              "name": "path",
              "type": "string",
              "description": "directory path",
              "example": "dir1"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/quota_project_directories",
          "method": "DELETE",
          "description": "Remove directory from Quota Project",
          "parameters": [
            {
              "name": "project_id",
              "type": "string",
              "example": "proj-00000001"
            },
            {
              "name": "path",
              "type": "string",
              "description": "directory path",
              "example": "dir1"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/attach_permissions",
          "method": "POST",
          "description": "Set volume attach permissions to a server.",
          "parameters": [
            {
              "name": "server_name",
              "description": "The attached server.",
              "required": true,
              "type": "string",
              "example": "srv-00000001"
            },
            {
              "name": "read_only",
              "description": "Set attach permissions to Read only or Read/Write.",
              "required": true,
              "type": "boolean"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-volume-perms-response>\n    <status type=\"integer\">0</status>\n</update-volume-perms-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_volume_perf-response>\n    <volume-name>volume-00000001</volume-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985186</point>\n        </usage>\n        <usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985187</point>\n        </usage>\n    </usages>\n</get_volume_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"volume_name\": \"volume-00000001\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985186\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985187\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/update_protection",
          "method": "POST",
          "description": "Sets capacity thresholds. A support ticket will be created when your Volume reaches specified capacity thresholds.",
          "parameters": [
            {
              "name": "alertmode",
              "type": "integer",
              "example": 360,
              "description": "Alert me when it is estimated that the Volume will be at full capacity in X minutes."
            },
            {
              "name": "emergencymode",
              "type": "integer",
              "example": 360,
              "description": "When the Volume has less than this number of GB left, the volume will start deleting snapshots, starting with the oldest, and trigger auto expand."
            },
            {
              "name": "capacityhistory",
              "type": "integer",
              "example": 60,
              "description": "Window size in minutes which is used to calculate the rate of which free Volume capacity is consumed. This rate is used to calculate the estimated time until a Volume is full"
            },
            {
              "name": "autoexpand",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable capacity auto expand",
              "example": "YES"
            },
            {
              "name": "maxcapacity",
              "type": "string",
              "example": "300G",
              "description": "Max Capacity to expand in GB followed by the letter G."
            },
            {
              "name": "autoexpandby",
              "type": "string",
              "example": "300G",
              "description": "Capacity to expand by in GB followed by the letter G."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-volume-capacity-thresholds-response>\n  <vol-name>volume-00000002</vol-name>\n  <status type=\"integer\">0</status>\n</update-volume-capacity-thresholds-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/update_performance_thresholds",
          "method": "POST",
          "description": "Sets performance thresholds. A support ticket will be created when your volume reaches specified performance thresholds.",
          "parameters": [
            {
              "name": "read_iops_limit",
              "type": "integer",
              "example": 5000,
              "description": "Alert me when the average read IOPS for this volume exceeds this number of IOPS."
            },
            {
              "name": "read_mbps_limit",
              "type": "integer",
              "example": 100,
              "description": "Alert me when the average read throughput for this volume exceeds this number of MB/s."
            },
            {
              "name": "read_latency_limit",
              "type": "integer",
              "example": 50,
              "description": "Alert me when the average read latency for this volume exceeds this number of ms."
            },
            {
              "name": "write_iops_limit",
              "type": "integer",
              "example": 5000,
              "description": "Alert me when the average write IOPS for this volume exceeds this number of IOPS."
            },
            {
              "name": "write_mbps_limit",
              "type": "integer",
              "example": 100,
              "description": "Alert me when the average write throughput for this volume exceeds this number of MB/s."
            },
            {
              "name": "write_latency_limit",
              "type": "integer",
              "example": 50,
              "description": "Alert me when the average write latency for this volume exceeds this number of ms."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-volume-perf-thresholds-response>\n  <vol-name>volume-00000005</vol-name>\n  <status type=\"integer\">0</status>\n</update-volume-perf-thresholds-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/audited_volumes/logs_timerange",
          "method": "GET",
          "description": "Get the volumes file access auditing log times range in UTC timezone.",
          "parameters": [
            {
              "name": "readable",
              "type": "string",
              "description": "Include this parameter to get times in readable format like 2020-08-30 13:37:00 UTC. If not included, times are in seconds since epoch UTC.",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <from-date-time type=\"dateTime\">2020-08-20 18:23:00 UTC</from-date-time>\n  <to-date-time type=\"dateTime\">2020-08-30 13:37:00 UTC</to-date-time>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"from_date_time\": \"2020-08-20 18:23:00 UTC\",\n    \"to_date_time\": \"2020-08-30 13:37:00 UTC\"\n  }\n}"
        },
        {
          "uri": "/audited_volumes/download",
          "method": "GET",
          "description": "Get the volumes file access auditing log files, in a single zip file.",
          "parameters": [
            {
              "name": "from",
              "type": "string",
              "description": "Starting date and time of audit log section to get ('year-month-day hour-minute-seconds' format).",
              "required": false,
              "example": "2020-08-20 18:23:00"
            },
            {
              "name": "to",
              "type": "string",
              "description": "Ending date and time of audit log section to get ('year-month-day hour-minute-seconds' format).",
              "required": false,
              "example": "2020-08-30 13:37:00"
            }
          ],
          "redirection": "zadara_audit.zip"
        },
        {
          "uri": "/volumes/{id}/tags",
          "method": "GET",
          "description": "Get volume tags.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-object-tags-response>\n  <status type=\"integer\">0</status>\n  <tags-count type=\"integer\">2</tags-count>\n  <tags type=\"array\">\n    <tag>\n      <name>tag-00000003</name>\n      <key>key1</key>\n      <value>value1</value>\n    </tag>\n    <tag>\n      <name>tag-00000005</name>\n      <key>key2</key>\n      <value>value2</value>\n    </tag>\n  </tags>\n</show-object-tags-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"tags\": [\n      {\n        \"name\": \"tag-00000003\",\n        \"key\": \"key1\",\n        \"value\": \"value1\"\n      },\n      {\n        \"name\": \"tag-00000005\",\n        \"key\": \"key2\",\n        \"value\": \"value2\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/tags",
          "method": "POST",
          "description": "Create a tag for volume.",
          "parameters": [
            {
              "name": "key",
              "type": "string",
              "description": "The tag name.",
              "required": true,
              "example": "tag_key"
            },
            {
              "name": "value",
              "type": "string",
              "description": "The tag value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add-object-tag-response>\n  <tag-name>tag-00000019</tag-name>\n  <status type=\"integer\">0</status>\n</add-object-tag-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000019\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/tags/{tag_key}",
          "method": "PUT",
          "description": "Update a tag for volume.",
          "parameters": [
            {
              "name": "value",
              "type": "string",
              "description": "The tag new value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</update-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/volumes/{id}/tags/{tag_key}",
          "method": "DELETE",
          "description": "Deletes a tag from volume.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</delete-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "File Lifecycle",
      "description": "Operations involving File Lifecycle.",
      "methods": [
        {
          "uri": "/flc/categories_settings",
          "method": "GET",
          "description": "Show file lifecycle categories and their file extensions.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-flc-categories-response>\n  <status type=\"integer\">0</status>\n  <categories-count type=\"integer\">12</categories-count>\n  <categories type=\"array\">\n    <category>\n      <extensions-count type=\"integer\">13</extensions-count>\n      <category-ext-name>category-00000002</category-ext-name>\n      <category-name>Email Data</category-name>\n      <extension>pst</extension>\n      <extension>nsf</extension>\n      <extension>ns2</extension>\n      <extension>ns3</extension>\n      <extension>ns4</extension>\n      <extension>box</extension>\n      <extension>ncf</extension>\n      <extension>ntf</extension>\n      <extension>eml</extension>\n      <extension>emlx</extension>\n      <extension>ost</extension>\n      <extension>vcf</extension>\n      <extension>ics</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">3</extensions-count>\n      <category-ext-name>category-00000003</category-ext-name>\n      <category-name>Backup files</category-name>\n      <extension>bak</extension>\n      <extension>bkp</extension>\n      <extension>bkf</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">6</extensions-count>\n      <category-ext-name>category-00000004</category-ext-name>\n      <category-name>Disk Images</category-name>\n      <extension>iso</extension>\n      <extension>nrg</extension>\n      <extension>img</extension>\n      <extension>tib</extension>\n      <extension>gho</extension>\n      <extension>ghs</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">9</extensions-count>\n      <category-ext-name>category-00000005</category-ext-name>\n      <category-name>Server Virtualization</category-name>\n      <extension>vmdk</extension>\n      <extension>nvram</extension>\n      <extension>vmx</extension>\n      <extension>vmxf</extension>\n      <extension>vmtm</extension>\n      <extension>vmem</extension>\n      <extension>vmsn</extension>\n      <extension>vmsd</extension>\n      <extension>hlog</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">8</extensions-count>\n      <category-ext-name>category-00000006</category-ext-name>\n      <category-name>Image files</category-name>\n      <extension>bmp</extension>\n      <extension>gif</extension>\n      <extension>jpg</extension>\n      <extension>jpeg</extension>\n      <extension>tif</extension>\n      <extension>tiff</extension>\n      <extension>png</extension>\n      <extension>psd</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">30</extensions-count>\n      <category-ext-name>category-00000007</category-ext-name>\n      <category-name>Documents, Spreadsheets and text files</category-name>\n      <extension>doc</extension>\n      <extension>docx</extension>\n      <extension>docm</extension>\n      <extension>dot</extension>\n      <extension>dotx</extension>\n      <extension>dotm</extension>\n      <extension>xls</extension>\n      <extension>xlsx</extension>\n      <extension>xlsm</extension>\n      <extension>xlt</extension>\n      <extension>xltx</extension>\n      <extension>xltm</extension>\n      <extension>xlsb</extension>\n      <extension>xlam</extension>\n      <extension>ppt</extension>\n      <extension>pptx</extension>\n      <extension>pptm</extension>\n      <extension>potx</extension>\n      <extension>potm</extension>\n      <extension>ppam</extension>\n      <extension>ppsx</extension>\n      <extension>ppsm</extension>\n      <extension>mdb</extension>\n      <extension>accdb</extension>\n      <extension>accde</extension>\n      <extension>accdt</extension>\n      <extension>accdr</extension>\n      <extension>txt</extension>\n      <extension>csv</extension>\n      <extension>pdf</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">11</extensions-count>\n      <category-ext-name>category-00000008</category-ext-name>\n      <category-name>Temporary files</category-name>\n      <extension>temp</extension>\n      <extension>tmp</extension>\n      <extension>cfa</extension>\n      <extension>~cr</extension>\n      <extension>loaded_0</extension>\n      <extension>loaded_1</extension>\n      <extension>loaded_2</extension>\n      <extension>loaded_3</extension>\n      <extension>dmp</extension>\n      <extension>csd</extension>\n      <extension>aso</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">6</extensions-count>\n      <category-ext-name>category-00000009</category-ext-name>\n      <category-name>Audio files</category-name>\n      <extension>aiff</extension>\n      <extension>au</extension>\n      <extension>mp3</extension>\n      <extension>mp4</extension>\n      <extension>wav</extension>\n      <extension>wma</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">6</extensions-count>\n      <category-ext-name>category-0000000a</category-ext-name>\n      <category-name>Archive files</category-name>\n      <extension>zip</extension>\n      <extension>tar</extension>\n      <extension>cab</extension>\n      <extension>gz</extension>\n      <extension>rar</extension>\n      <extension>z</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">1</extensions-count>\n      <category-ext-name>category-0000000b</category-ext-name>\n      <category-name>Installers renamed</category-name>\n      <extension>ext1</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">5</extensions-count>\n      <category-ext-name>category-0000000f</category-ext-name>\n      <category-name>Video files</category-name>\n      <extension>m4v</extension>\n      <extension>mov</extension>\n      <extension>avi</extension>\n      <extension>mpeg</extension>\n      <extension>mpg</extension>\n    </category>\n    <category>\n      <extensions-count type=\"integer\">1</extensions-count>\n      <category-ext-name>category-00000010</category-ext-name>\n      <category-name>newCat</category-name>\n      <extension>ext2</extension>\n    </category>\n  </categories>\n</show-flc-categories-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"categories\": [\n      {\n        \"extensions_count\": 13,\n        \"category_ext_name\": \"category-00000002\",\n        \"category_name\": \"Email Data\",\n        \"extension\": [\n          \"pst\",\n          \"nsf\",\n          \"ns2\",\n          \"ns3\",\n          \"ns4\",\n          \"box\",\n          \"ncf\",\n          \"ntf\",\n          \"eml\",\n          \"emlx\",\n          \"ost\",\n          \"vcf\",\n          \"ics\"\n        ]\n      },\n      {\n        \"extensions_count\": 3,\n        \"category_ext_name\": \"category-00000003\",\n        \"category_name\": \"Backup files\",\n        \"extension\": [\n          \"bak\",\n          \"bkp\",\n          \"bkf\"\n        ]\n      },\n      {\n        \"extensions_count\": 6,\n        \"category_ext_name\": \"category-00000004\",\n        \"category_name\": \"Disk Images\",\n        \"extension\": [\n          \"iso\",\n          \"nrg\",\n          \"img\",\n          \"tib\",\n          \"gho\",\n          \"ghs\"\n        ]\n      },\n      {\n        \"extensions_count\": 9,\n        \"category_ext_name\": \"category-00000005\",\n        \"category_name\": \"Server Virtualization\",\n        \"extension\": [\n          \"vmdk\",\n          \"nvram\",\n          \"vmx\",\n          \"vmxf\",\n          \"vmtm\",\n          \"vmem\",\n          \"vmsn\",\n          \"vmsd\",\n          \"hlog\"\n        ]\n      },\n      {\n        \"extensions_count\": 8,\n        \"category_ext_name\": \"category-00000006\",\n        \"category_name\": \"Image files\",\n        \"extension\": [\n          \"bmp\",\n          \"gif\",\n          \"jpg\",\n          \"jpeg\",\n          \"tif\",\n          \"tiff\",\n          \"png\",\n          \"psd\"\n        ]\n      },\n      {\n        \"extensions_count\": 30,\n        \"category_ext_name\": \"category-00000007\",\n        \"category_name\": \"Documents, Spreadsheets and text files\",\n        \"extension\": [\n          \"doc\",\n          \"docx\",\n          \"docm\",\n          \"dot\",\n          \"dotx\",\n          \"dotm\",\n          \"xls\",\n          \"xlsx\",\n          \"xlsm\",\n          \"xlt\",\n          \"xltx\",\n          \"xltm\",\n          \"xlsb\",\n          \"xlam\",\n          \"ppt\",\n          \"pptx\",\n          \"pptm\",\n          \"potx\",\n          \"potm\",\n          \"ppam\",\n          \"ppsx\",\n          \"ppsm\",\n          \"mdb\",\n          \"accdb\",\n          \"accde\",\n          \"accdt\",\n          \"accdr\",\n          \"txt\",\n          \"csv\",\n          \"pdf\"\n        ]\n      },\n      {\n        \"extensions_count\": 11,\n        \"category_ext_name\": \"category-00000008\",\n        \"category_name\": \"Temporary files\",\n        \"extension\": [\n          \"temp\",\n          \"tmp\",\n          \"cfa\",\n          \"~cr\",\n          \"loaded_0\",\n          \"loaded_1\",\n          \"loaded_2\",\n          \"loaded_3\",\n          \"dmp\",\n          \"csd\",\n          \"aso\"\n        ]\n      },\n      {\n        \"extensions_count\": 6,\n        \"category_ext_name\": \"category-00000009\",\n        \"category_name\": \"Audio files\",\n        \"extension\": [\n          \"aiff\",\n          \"au\",\n          \"mp3\",\n          \"mp4\",\n          \"wav\",\n          \"wma\"\n        ]\n      },\n      {\n        \"extensions_count\": 6,\n        \"category_ext_name\": \"category-0000000a\",\n        \"category_name\": \"Archive files\",\n        \"extension\": [\n          \"zip\",\n          \"tar\",\n          \"cab\",\n          \"gz\",\n          \"rar\",\n          \"z\"\n        ]\n      },\n      {\n        \"extensions_count\": 1,\n        \"category_ext_name\": \"category-0000000b\",\n        \"category_name\": \"Installers renamed\",\n        \"extension\": \"ext1\"\n      },\n      {\n        \"extensions_count\": 5,\n        \"category_ext_name\": \"category-0000000f\",\n        \"category_name\": \"Video files\",\n        \"extension\": [\n          \"m4v\",\n          \"mov\",\n          \"avi\",\n          \"mpeg\",\n          \"mpg\"\n        ]\n      },\n      {\n        \"extensions_count\": 1,\n        \"category_ext_name\": \"category-00000010\",\n        \"category_name\": \"newCat\",\n        \"extension\": \"ext2\"\n      }\n    ],\n    \"count\": 12\n  }\n}"
        },
        {
          "uri": "/flc/create_category",
          "method": "POST",
          "description": "Create a new file lifecycle category with its file extensions.",
          "parameters": [
            {
              "name": "displayname",
              "type": "string",
              "required": true,
              "description": "Category name.",
              "example": "Video Files"
            },
            {
              "name": "file_extensions",
              "type": "string",
              "required": true,
              "description": "File extensions list.",
              "example": "avi,mpg,mpeg"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-flc-category-response>\n  <status type=\"integer\">0</status>\n  <category-ext-name type=\"string\">category-00000010</category-ext-name>\n</create-flc-category-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"category_ext_name\": \"category-00000010\"\n  }\n}"
        },
        {
          "uri": "/flc/update_category",
          "method": "POST",
          "description": "Update an existing file lifecycle category to change its file extensions.",
          "parameters": [
            {
              "name": "category",
              "type": "string",
              "required": true,
              "description": "Existing category ID ('category-ext-name' field).",
              "example": "category-00000010"
            },
            {
              "name": "file_extensions",
              "type": "string",
              "required": true,
              "description": "File extensions list.",
              "example": "avi,mpg,mpeg"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-flc-category-response>\n  <status type=\"integer\">0</status>\n</update-flc-category-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc/rename_category",
          "method": "POST",
          "description": "Rename an existing file lifecycle category.",
          "parameters": [
            {
              "name": "category",
              "type": "string",
              "required": true,
              "description": "Existing category ID ('category-ext-name' field).",
              "example": "category-00000010"
            },
            {
              "name": "displayname",
              "type": "string",
              "required": true,
              "description": "New category name.",
              "example": "Audio Files"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<rename-flc-category-response>\n  <status type=\"integer\">0</status>\n</rename-flc-category-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc/delete_category",
          "method": "DELETE",
          "description": "Delete a file lifecycle category.",
          "parameters": [
            {
              "name": "category",
              "type": "string",
              "required": true,
              "description": "Category ID ('category-ext-name' field).",
              "example": "category-00000010"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<delete-flc-category-response>\n  <status type=\"integer\">0</status>\n</delete-flc-category-response>",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "File Lifecycle Policies",
      "description": "Operations involving File Lifecycle Policies.",
      "methods": [
        {
          "uri": "/flc_policies",
          "method": "GET",
          "description": "Show file lifecycle policies.",
          "parameters": [
            {
              "name": "first",
              "type": "integer",
              "required": false,
              "description": "Retrieve policies starting from the given index. Can be used for pagination with the number parameter."
            },
            {
              "name": "number",
              "type": "integer",
              "required": false,
              "description": "Retrieve the given number of policies. Can be used for pagination with the first parameter."
            },
            {
              "name": "order_by",
              "type": "string",
              "required": false,
              "description": "Order policies by given attribute."
            },
            {
              "name": "descend",
              "type": "string",
              "required": false,
              "options": "YES | NO",
              "description": "Controls order direction."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-life-cycle-policies-response>\n  <status type=\"integer\">0</status>\n  <lc-policies-count type=\"integer\">2</lc-policies-count>\n  <lc-policies type=\"array\">\n    <life-cycle-policy>\n      <name>lc-policy-00000002</name>\n      <display-name>policy1</display-name>\n      <enabled>YES</enabled>\n      <dry-run-mode>YES</dry-run-mode>\n      <use-recycle-bin>NO</use-recycle-bin>\n      <file-selection-criteria>{ \"$and\": [ { \"$in\": [\"$extension\", [\"log\", \"tmp\"]] }, { \"$gt\": [\"$size\", 1024] } ] }</file-selection-criteria>\n      <whitelist-paths/>\n      <blacklist-paths/>\n      <action>expire</action>\n      <created-at type=\"datetime\">2021-04-19T12:02:59+0300</created-at>\n      <modified-at type=\"datetime\">2021-04-20T12:12:56+0300</modified-at>\n    </life-cycle-policy>\n    <life-cycle-policy>\n      <name>lc-policy-00000003</name>\n      <display-name>policy2</display-name>\n      <enabled>YES</enabled>\n      <dry-run-mode>NO</dry-run-mode>\n      <use-recycle-bin>NO</use-recycle-bin>\n      <file-selection-criteria>{ \"$and\": [ { \"$in\": [\"$extension\", [\"log\", \"tmp\"]] }, { \"$gt\": [\"$size\", 1024] } ] }</file-selection-criteria>\n      <whitelist-paths>/tmp</whitelist-paths>\n      <blacklist-paths>/var,/etc</blacklist-paths>\n      <action>expire</action>\n      <created-at type=\"datetime\">2021-04-20T11:02:08+0300</created-at>\n      <modified-at type=\"datetime\">2021-04-20T12:43:55+0300</modified-at>\n    </life-cycle-policy>\n  </lc-policies>\n</show-life-cycle-policies-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"lc_policies\": [\n      {\n        \"name\": \"lc-policy-00000002\",\n        \"display_name\": \"policy1\",\n        \"enabled\": \"YES\",\n        \"dry_run_mode\": \"YES\",\n        \"use_recycle_bin\": \"NO\",\n        \"file_selection_criteria\": \"{ \\\"$and\\\": [ { \\\"$in\\\": [\\\"$extension\\\", [\\\"log\\\", \\\"tmp\\\"]] }, { \\\"$gt\\\": [\\\"$size\\\", 1024] } ] }\",\n        \"whitelist_paths\": null,\n        \"blacklist_paths\": null,\n        \"action\": \"expire\",\n        \"created_at\": \"2021-04-19 09:02:59 UTC\",\n        \"modified_at\": \"2021-04-20 09:12:56 UTC\"\n      },\n      {\n        \"name\": \"lc-policy-00000003\",\n        \"display_name\": \"policy2\",\n        \"enabled\": \"YES\",\n        \"dry_run_mode\": \"NO\",\n        \"use_recycle_bin\": \"NO\",\n        \"file_selection_criteria\": \"{ \\\"$and\\\": [ { \\\"$in\\\": [\\\"$extension\\\", [\\\"log\\\", \\\"tmp\\\"]] }, { \\\"$gt\\\": [\\\"$size\\\", 1024] } ] }\",\n        \"whitelist_paths\": \"/tmp\",\n        \"blacklist_paths\": \"/var,/etc\",\n        \"action\": \"expire\",\n        \"created_at\": \"2021-04-20 08:02:08 UTC\",\n        \"modified_at\": \"2021-04-20 09:43:55 UTC\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/flc_policies",
          "method": "GET",
          "description": "Show file lifecycle policies attached to a given volume.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": false,
              "description": "The volume to filter policies by."
            },
            {
              "name": "first",
              "type": "integer",
              "required": false,
              "description": "Retrieve policies starting from the given index. Can be used for pagination with the number parameter."
            },
            {
              "name": "number",
              "type": "integer",
              "required": false,
              "description": "Retrieve the given number of policies. Can be used for pagination with the first parameter."
            },
            {
              "name": "order_by",
              "type": "string",
              "required": false,
              "description": "Order policies by given attribute."
            },
            {
              "name": "descend",
              "type": "string",
              "required": false,
              "options": "YES | NO",
              "description": "Controls order direction."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        },
        {
          "uri": "/flc_policies/rules",
          "method": "GET",
          "description": "Show the rules attaching file lifecycle policies to volumes.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": false,
              "description": "Retrieve only rules relevant to the given volume."
            },
            {
              "name": "policy_name",
              "type": "string",
              "required": false,
              "description": "Retrieve only rules relevant to the given policy."
            },
            {
              "name": "first",
              "type": "integer",
              "required": false,
              "description": "Retrieve rules starting from the given index. Can be used for pagination with the number parameter."
            },
            {
              "name": "number",
              "type": "integer",
              "required": false,
              "description": "Retrieve the given number of rules. Can be used for pagination with the first parameter."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        },
        {
          "uri": "/flc_policies",
          "method": "POST",
          "description": "Create a new file lifecycle policy.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "description": "Policy name.",
              "example": "my_policy"
            },
            {
              "name": "file_selection_criteria",
              "type": "string",
              "required": true,
              "description": "The criteria by which the policy files will be selected. Should be in a MongoDB $match aggregation format.",
              "example": "{ \"$and\": [ { \"$in\": [\"$extension\", [\"log\", \"tmp\"]] }, { \"$gt\": [\"$size\", 1024] } ] }"
            },
            {
              "name": "lc_action",
              "type": "string",
              "required": true,
              "description": "The action that the policy performs on the selected files.",
              "options": "archive | expire",
              "example": "expire"
            },
            {
              "name": "enabled",
              "type": "string",
              "required": false,
              "description": "Controls enablement of the policy after it is created.",
              "options": "YES | NO"
            },
            {
              "name": "dry_run",
              "type": "string",
              "required": false,
              "description": "When the policy is in dry run mode, it'll only print its actions to the log instead of actually performing them.",
              "options": "YES | NO"
            },
            {
              "name": "use_recycle_bin",
              "type": "string",
              "required": false,
              "description": "When using recycle bin, files that are handled by the policy are also copied to the recycle bin.",
              "options": "YES | NO"
            },
            {
              "name": "whitelist_paths",
              "type": "string",
              "required": false,
              "description": "Comma delimited list of paths that the policy should only run on them."
            },
            {
              "name": "blacklist_paths",
              "type": "string",
              "required": false,
              "description": "Comma delimited list of paths that the policy should not run on."
            },
            {
              "name": "dest_obs_name",
              "type": "string",
              "required": false,
              "description": "Destination object storage to archive files to. Relevant only for archive policy."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-life-cycle-policy-response>\n  <status type=\"integer\">0</status>\n</create-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc_policies/{id}",
          "method": "PUT",
          "description": "Updates an existing file lifecycle policy.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": false,
              "description": "Policy name.",
              "example": "my_policy"
            },
            {
              "name": "file_selection_criteria",
              "type": "string",
              "required": false,
              "description": "The criteria by which the policy files will be selected. Should be in a MongoDB $match aggregation format.",
              "example": "{ \"$and\": [ { \"$in\": [\"$extension\", [\"log\", \"tmp\"]] }, { \"$gt\": [\"$size\", 1024] } ] }"
            },
            {
              "name": "lc_action",
              "type": "string",
              "required": false,
              "description": "The action that the policy performs on the selected files.",
              "options": "archive | expire",
              "example": "expire"
            },
            {
              "name": "enabled",
              "type": "string",
              "required": false,
              "description": "Controls enablement of the policy after it is created.",
              "options": "YES | NO"
            },
            {
              "name": "dry_run",
              "type": "string",
              "required": false,
              "description": "When the policy is in dry run mode, it'll only print its actions to the log instead of actually performing them.",
              "options": "YES | NO"
            },
            {
              "name": "use_recycle_bin",
              "type": "string",
              "required": false,
              "description": "When using recycle bin, files that are handled by the policy are also copied to the recycle bin.",
              "options": "YES | NO"
            },
            {
              "name": "whitelist_paths",
              "type": "string",
              "required": false,
              "description": "Comma delimited list of paths that the policy should only run on them."
            },
            {
              "name": "blacklist_paths",
              "type": "string",
              "required": false,
              "description": "Comma delimited list of paths that the policy should not run on."
            },
            {
              "name": "dest_obs_name",
              "type": "string",
              "required": false,
              "description": "Destination object storage to archive files to."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-life-cycle-policy-response>\n  <lc-policy-name>lc-policy-00000003</lc-policy-name>\n  <status type=\"integer\">0</status>\n</update-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"lc_policy_name\": \"lc-policy-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc_policies/{id}",
          "method": "GET",
          "description": "Retreive a specific file lifecycle policy.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-life-cycle-policy-response>\n  <status type=\"integer\">0</status>\n  <life-cycle-policy>\n    <name>lc-policy-00000002</name>\n    <display-name>policy2</display-name>\n    <enabled>YES</enabled>\n    <dry-run-mode>YES</dry-run-mode>\n    <use-recycle-bin>NO</use-recycle-bin>\n    <file-selection-criteria>{ \"$and\": [ { \"$in\": [\"$extension\", [\"log\", \"tmp\"]] }, { \"$gt\": [\"$size\", 1024] } ] }</file-selection-criteria>\n    <whitelist-paths/>\n    <blacklist-paths/>\n    <action>expire</action>\n    <created-at type=\"datetime\">2021-04-19T12:02:59+0300</created-at>\n    <modified-at type=\"datetime\">2021-04-20T12:12:56+0300</modified-at>\n  </life-cycle-policy>\n</show-one-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"life_cycle_policy\": {\n      \"name\": \"lc-policy-00000002\",\n      \"display_name\": \"policy2\",\n      \"enabled\": \"YES\",\n      \"dry_run_mode\": \"YES\",\n      \"use_recycle_bin\": \"NO\",\n      \"file_selection_criteria\": \"{ \\\"$and\\\": [ { \\\"$in\\\": [\\\"$extension\\\", [\\\"log\\\", \\\"tmp\\\"]] }, { \\\"$gt\\\": [\\\"$size\\\", 1024] } ] }\",\n      \"whitelist_paths\": null,\n      \"blacklist_paths\": null,\n      \"action\": \"expire\",\n      \"created_at\": \"2021-04-19 09:02:59 UTC\",\n      \"modified_at\": \"2021-04-20 09:12:56 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/flc_policies/{id}",
          "method": "DELETE",
          "description": "Delete a file lifecycle policy.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-life-cycle-policy-response>\n  <lc-policy-name>lc-policy-00000003</lc-policy-name>\n  <status type=\"integer\">0</status>\n</delete-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"lc_policy_name\": \"lc-policy-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc_policies/scheduling",
          "method": "PUT",
          "description": "Updates lifecycle policies run time scheduling.",
          "parameters": [
            {
              "name": "policy_start_time",
              "type": "string",
              "required": false,
              "description": "The start time in seconds from 00:00 AM.",
              "example": 9700
            },
            {
              "name": "policy_interval",
              "type": "integer",
              "required": false,
              "description": "The interval in seconds between running policies.",
              "example": 86400
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        },
        {
          "uri": "/flc_policies/recycle_bin",
          "method": "PUT",
          "description": "Configures the recycle bin.",
          "parameters": [
            {
              "name": "retention_time",
              "type": "string",
              "required": false,
              "description": "The time in seconds for retaining files in the recycle bin.",
              "example": 2592000
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        },
        {
          "uri": "/flc_policies/{id}/pause",
          "method": "PUT",
          "description": "Pause a file lifecycle policy for a given volume.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": true,
              "description": "The volume to pause the policy for."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-life-cycle-policy-response>\n  <lc-policy-name>lc-policy-00000005</lc-policy-name>\n  <status type=\"integer\">0</status>\n</update-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"lc_policy_name\": \"lc-policy-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc_policies/{id}/resume",
          "method": "PUT",
          "description": "Resume a file lifecycle policy for a given volume.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": true,
              "description": "The volume to resume the policy for."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-life-cycle-policy-response>\n  <lc-policy-name>lc-policy-00000005</lc-policy-name>\n  <status type=\"integer\">0</status>\n</update-life-cycle-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"lc_policy_name\": \"lc-policy-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/flc_policies/{id}/attach",
          "method": "PUT",
          "description": "Attach a volume to a file lifecycle policy.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": true,
              "description": "The volume to attach the policy to."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        },
        {
          "uri": "/flc_policies/{id}/detach",
          "method": "PUT",
          "description": "Detach a volume from a file lifecycle policy.",
          "parameters": [
            {
              "name": "volume_name",
              "type": "string",
              "required": true,
              "description": "The volume to detach the policy from."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<TODO/>\n",
          "response_json": "{\n  \"TODO\": null\n}"
        }
      ]
    },
    {
      "name": "Servers",
      "description": "Operations involving Servers.",
      "methods": [
        {
          "uri": "/servers",
          "method": "GET",
          "description": "Show all Servers.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-servers-response>\n    <status type=\"integer\">0</status>\n    <servers-count type=\"integer\">1</servers-count>\n    <servers type=\"array\">\n        <server>\n            <name>srv-00000001</name>\n            <display-name>server01</display-name>\n            <iqn>127.0.0.1</iqn>\n            <iscsi-ip />\n            <ipsec-iscsi>0</ipsec-iscsi>\n            <ipsec-nfs>0</ipsec-nfs>\n            <status>Active</status>\n            <os />\n            <registered>no</registered>\n            <last-check-time type=\"datetime\">2013-09-26 18:00:00</last-check-time>\n            <last-state-change-time type=\"datetime\">2013-09-26 18:00:00</last-state-change-time>\n            <created-at type=\"datetime\">2013-09-26 11:51:40</created-at>\n            <modified-at type=\"datetime\">2013-09-26 11:51:40</modified-at>\n        </server>\n    </servers>\n</show-servers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"servers\": [\n      {\n        \"name\": \"srv-00000001\",\n        \"display_name\": \"server01\",\n        \"iqn\": \"127.0.0.1\",\n        \"iscsi_ip\": null,\n        \"ipsec_iscsi\": \"0\",\n        \"ipsec_nfs\": \"0\",\n        \"status\": \"Active\",\n        \"os\": null,\n        \"registered\": \"no\",\n        \"last_check_time\": \"2013-09-26 18:00:00 UTC\",\n        \"last_state_change_time\": \"2013-09-26 18:00:00 UTC\",\n        \"created_at\": \"2013-09-26 11:51:40 UTC\",\n        \"modified_at\": \"2013-09-26 11:51:40 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/servers/{id}",
          "method": "GET",
          "description": "Show a single Server.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-server-response>\n    <status type=\"integer\">0</status>\n    <server>\n        <name>srv-00000001</name>\n        <display-name>server01</display-name>\n        <iqn>127.0.0.1</iqn>\n        <iscsi-ip />\n        <ipsec-iscsi>0</ipsec-iscsi>\n        <ipsec-nfs>0</ipsec-nfs>\n        <status>Active</status>\n        <os />\n        <registered>no</registered>\n        <last-check-time type=\"datetime\">2013-09-26 18:00:00</last-check-time>\n        <last-state-change-time type=\"datetime\">2013-09-26 18:00:00</last-state-change-time>\n        <created-at type=\"datetime\">2013-09-26 11:51:40</created-at>\n        <modified-at type=\"datetime\">2013-09-26 11:51:40</modified-at>\n    </server>\n</show-one-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"server\": {\n      \"name\": \"srv-00000001\",\n      \"display_name\": \"server01\",\n      \"iqn\": \"127.0.0.1\",\n      \"iscsi_ip\": null,\n      \"ipsec_iscsi\": \"0\",\n      \"ipsec_nfs\": \"0\",\n      \"status\": \"Active\",\n      \"os\": null,\n      \"registered\": \"no\",\n      \"last_check_time\": \"2013-09-26 18:00:00 UTC\",\n      \"last_state_change_time\": \"2013-09-26 18:00:00 UTC\",\n      \"created_at\": \"2013-09-26 11:51:40 UTC\",\n      \"modified_at\": \"2013-09-26 11:51:40 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/servers",
          "method": "POST",
          "description": "Create a new Server. IQN or iSCSI ip or FC WWPN must be provided.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "required": true,
              "example": "my-server",
              "description": "The new server display name"
            },
            {
              "name": "os",
              "type": "string",
              "example": "Windows",
              "description": "Server's OS",
              "options": "Windows | Linux | Solaris | AIX | ESXi"
            },
            {
              "name": "vpsachapuser",
              "type": "string",
              "example": "johndoe",
              "description": "VPSA chap user."
            },
            {
              "name": "vpsachapsecret",
              "type": "string",
              "description": "VPSA chap secret. 12-16 characters.",
              "example": "tgbujmedcrfv"
            },
            {
              "name": "hostchapuser",
              "type": "string",
              "description": "Host chap user."
            },
            {
              "name": "hostchapsecret",
              "type": "string",
              "description": "Host chap secret. 12-16 characters."
            },
            {
              "name": "iqn",
              "type": "string",
              "description": "iSCSI Qualified Name"
            },
            {
              "name": "iscsi",
              "type": "string",
              "description": "The server's iSCSI IP",
              "example": "10.11.12.13"
            },
            {
              "name": "ipsec_iscsi",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable ipsec for iscsi for the server"
            },
            {
              "name": "ipsec_nfs",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable ipsec for nfs for the server"
            },
            {
              "name": "wwpns",
              "type": "Array",
              "description": "Fibre channel wwpns",
              "example_as_json_string": true,
              "example": "[\"21000024ff7bc174\", \"21000024ff7bc175\"]"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-server-response>\n    <server-name>srv-00000001</server-name>\n    <status type=\"integer\">0</status>\n</create-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"server_name\": \"srv-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}",
          "method": "DELETE",
          "description": "Delete a Server.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-server-response>\n    <server-name>srv-00000001</server-name>\n    <status type=\"integer\">0</status>\n</delete-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"server_name\": \"srv-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/sessions",
          "method": "GET",
          "description": "Lists server's sessions.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <count type=\"integer\">1</count>\n  <sessions type=\"array\">\n    <session>\n      <access-type>ISCSI</access-type>\n      <initiator>iqn.1991-05.com.microsoft:vm91-win2008r2.zadara.lab</initiator>\n      <target>iqn.test.com.zadarastorage:vsa-00000000:1</target>\n      <count type=\"integer\">1</count>\n      <vc type=\"integer\">0</vc>\n      <connected type=\"integer\">YES</connected>\n      <server-name>srv-00000003</server-name>\n      <server-display-name>VM91_WIN2008R2</server-display-name>\n    </session>\n  </sessions>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"sessions\": [\n      {\n        \"access_type\": \"ISCSI\",\n        \"initiator\": \"iqn.1991-05.com.microsoft:vm91-win2008r2.zadara.lab\",\n        \"target\": \"iqn.test.com.zadarastorage:vsa-00000000:1\",\n        \"count\": 1,\n        \"vc\": 0,\n        \"connected\": 0,\n        \"server_name\": \"srv-00000003\",\n        \"server_display_name\": \"VM91_WIN2008R2\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/servers/session",
          "method": "DELETE",
          "description": "Delete server's session.",
          "parameters": [
            {
              "name": "initiator",
              "type": "string",
              "required": true,
              "example": "2109034534",
              "description": "Session's Initiator"
            },
            {
              "name": "target",
              "type": "string",
              "example": "2444034534",
              "required": true,
              "description": "Session's Target"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/rename",
          "method": "POST",
          "description": "Rename a Server.",
          "parameters": [
            {
              "name": "new_name",
              "type": "string",
              "required": true,
              "description": "The server new name",
              "example": "new-server-name"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-server-response>\n    <server-name>srv-00000001</server-name>\n    <status type=\"integer\">0</status>\n</rename-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"server_name\": \"srv-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/config",
          "method": "POST",
          "description": "Update a Server configuration.",
          "parameters": [
            {
              "name": "display_name",
              "type": "string",
              "description": "The server display name"
            },
            {
              "name": "os",
              "type": "string",
              "example": "Windows",
              "description": "Server's OS",
              "options": "Windows | Linux | Solaris | AIX | ESXi"
            },
            {
              "name": "vpsachapuser",
              "type": "string",
              "description": "VPSA chap user."
            },
            {
              "name": "vpsachapsecret",
              "type": "string",
              "description": "VPSA chap secret. 12-16 characters."
            },
            {
              "name": "hostchapuser",
              "type": "string",
              "description": "Host chap user."
            },
            {
              "name": "hostchapsecret",
              "type": "string",
              "example": "qscfthnjgfrtyu",
              "description": "Host chap secret. 12-16 characters."
            },
            {
              "name": "iqn",
              "type": "string"
            },
            {
              "name": "iscsi",
              "type": "string",
              "description": "The server's iSCSI IP"
            },
            {
              "name": "ipsec_iscsi",
              "type": "string",
              "options": "YES, NO"
            },
            {
              "name": "ipsec_nfs",
              "type": "string",
              "options": "YES, NO"
            },
            {
              "name": "monitoring",
              "type": "string",
              "options": "YES, NO",
              "description": "connectivity monitoring"
            },
            {
              "name": "remove_wwpns",
              "type": "Array",
              "description": "wwpns to remove"
            },
            {
              "name": "add_wwpns",
              "type": "Array",
              "description": "wwpns to add"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-server-response>\n    <server-name>srv-00000001</server-name>\n    <status type=\"integer\">0</status>\n</update-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"server_name\": \"srv-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/volumes",
          "method": "GET",
          "description": "Returns a list of Volumes attached to the Server.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-volumes-in-server-response>\n    <status type=\"integer\">0</status>\n    <volumes-count type=\"integer\">1</volumes-count>\n    <volumes type=\"array\">\n        <volume>\n            <name>volume-00000001</name>\n            <display-name>volume</display-name>\n            <cg-display-name>volume</cg-display-name>\n            <cg-name>cg-00000001</cg-name>\n            <cg-user-created>NO</cg-user-created>\n            <pool-display-name>poolrenamed</pool-display-name>\n            <pool-name>pool-00000001</pool-name>\n            <status>In-use</status>\n            <virtual-capacity type=\"integer\">300</virtual-capacity>\n            <server-name>server</server-name>\n            <data-type>BLOCK</data-type>\n            <thin>YES</thin>\n            <encryption>NO</encryption>\n            <access-type>ISCSI</access-type>\n            <read-only />\n            <export-name />\n            <mount-sync>NO</mount-sync>\n            <atime-update>NO</atime-update>\n            <target>iqn.2011-04.com.zadarastorage:vsa-000007bb:1</target>\n            <lun>0</lun>\n            <cache />\n            <read-iops-limit>0</read-iops-limit>\n            <read-mbps-limit>0</read-mbps-limit>\n            <write-iops-limit>0</write-iops-limit>\n            <write-mbps-limit>0</write-mbps-limit>\n            <created-at type=\"datetime\">2013-09-26 00:42:30</created-at>\n            <modified-at type=\"datetime\">2013-09-27 00:24:32</modified-at>\n        </volume>\n    </volumes>\n</show-volumes-in-server-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000001\",\n        \"display_name\": \"volume\",\n        \"cg_display_name\": \"volume\",\n        \"cg_name\": \"cg-00000001\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"poolrenamed\",\n        \"pool_name\": \"pool-00000001\",\n        \"status\": \"In-use\",\n        \"virtual_capacity\": 300,\n        \"server_name\": \"server\",\n        \"data_type\": \"BLOCK\",\n        \"thin\": \"YES\",\n        \"encryption\": \"NO\",\n        \"access_type\": \"ISCSI\",\n        \"read_only\": null,\n        \"export_name\": null,\n        \"mount_sync\": \"NO\",\n        \"atime_update\": \"NO\",\n        \"target\": \"iqn.2011-04.com.zadarastorage:vsa-000007bb:1\",\n        \"lun\": \"0\",\n        \"cache\": null,\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"created_at\": \"2013-09-26 00:42:30 UTC\",\n        \"modified_at\": \"2013-09-27 00:24:32 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/servers/{id}/volumes",
          "method": "POST",
          "description": "Attach Volume to Server(s).",
          "parameters": [
            {
              "name": "id",
              "type": "string",
              "description": "Comma-separated list of server IDs.",
              "required": true
            },
            {
              "name": "volume_name",
              "type": "string",
              "required": true,
              "example": "volume-00000001",
              "description": "The volume ID."
            },
            {
              "name": "access_type",
              "type": "string",
              "required": true,
              "options": "NFS, SMB, ISCSI",
              "example": "ISCSI",
              "description": "NFS/SMB for NAS, ISCSI for Block."
            },
            {
              "name": "lun",
              "type": "integer",
              "required": false,
              "example": 1
            },
            {
              "name": "readonly",
              "type": "string",
              "required": false,
              "options": "YES, NO",
              "description": "Relevant only to NFS/SMB"
            },
            {
              "name": "force",
              "type": "string",
              "required": false,
              "options": "YES, NO",
              "description": "Required only when volume is already attached to another server."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<attach-volume-response>\n    <status type=\"integer\">0</status>\n</attach-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_servers_perf-response>\n  <server-name>RaidGroup-4</server-name>\n  <status type=\"integer\">0</status>\n  <usages-count type=\"integer\">20</usages-count>\n  <usages type=\"array\">\n    <usage>\n        <rd-iops type=\"integer\">0</rd-iops>\n        <rd-iotime type=\"float\">0.000000</rd-iotime>\n        <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n        <rd-queue-len type=\"integer\">0</rd-queue-len>\n        <wrt-iops type=\"integer\">0</wrt-iops>\n        <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n        <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n        <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n        <point type=\"integer\">1386985241</point>\n    </usage>\n    <usage>\n        <rd-iops type=\"integer\">0</rd-iops>\n        <rd-iotime type=\"float\">0.000000</rd-iotime>\n        <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n        <rd-queue-len type=\"integer\">0</rd-queue-len>\n        <wrt-iops type=\"integer\">0</wrt-iops>\n        <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n        <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n        <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n        <point type=\"integer\">1386985242</point>\n    </usage>\n  </usages>\n</get_servers_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"server_name\": \"RaidGroup-4\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985241\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985242\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/servers/{id}/tags",
          "method": "GET",
          "description": "Get server tags.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-object-tags-response>\n  <status type=\"integer\">0</status>\n  <tags-count type=\"integer\">2</tags-count>\n  <tags type=\"array\">\n    <tag>\n      <name>tag-00000003</name>\n      <key>key1</key>\n      <value>value1</value>\n    </tag>\n    <tag>\n      <name>tag-00000005</name>\n      <key>key2</key>\n      <value>value2</value>\n    </tag>\n  </tags>\n</show-object-tags-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"tags\": [\n      {\n        \"name\": \"tag-00000003\",\n        \"key\": \"key1\",\n        \"value\": \"value1\"\n      },\n      {\n        \"name\": \"tag-00000005\",\n        \"key\": \"key2\",\n        \"value\": \"value2\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/servers/{id}/tags",
          "method": "POST",
          "description": "Create a tag for server.",
          "parameters": [
            {
              "name": "key",
              "type": "string",
              "description": "The tag name.",
              "required": true,
              "example": "tag_key"
            },
            {
              "name": "value",
              "type": "string",
              "description": "The tag value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<add-object-tag-response>\n  <tag-name>tag-00000019</tag-name>\n  <status type=\"integer\">0</status>\n</add-object-tag-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000019\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/tags/{tag_key}",
          "method": "PUT",
          "description": "Update a tag for server.",
          "parameters": [
            {
              "name": "value",
              "type": "string",
              "description": "The tag new value.",
              "required": true,
              "example": "tag_value"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</update-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/servers/{id}/tags/{tag_key}",
          "method": "DELETE",
          "description": "Deletes a tag from server.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-object-tag-by-key-response>\n  <tag-name>tag-00000003</tag-name>\n  <status type=\"integer\">0</status>\n</delete-object-tag-by-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"tag_name\": \"tag-00000003\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Controllers",
      "description": "Operations for Controllers.",
      "methods": [
        {
          "uri": "/vcontrollers",
          "method": "GET",
          "description": "Get a list of Controllers.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-vcontrollers-response>\n   <status type=\"integer\">0</status>\n   <vcontrollers-count type=\"integer\">2</vcontrollers-count>\n   <vcontrollers type=\"array\">\n      <vcontroller>\n         <name>vsa-00000038-vc-1</name>\n         <display-name>vsa-00000038-vc-1</display-name>\n         <index>1</index>\n         <state>standby</state>\n         <target>iqn.2011-04.com.zadarastorage:vsa-00000038:1</target>\n         <iscsi-ip>3.112.112.2</iscsi-ip>\n         <iscsi-ipv6>2001:db8:85a3::8a2e:370:7002</iscsi-ipv6>\n         <mgmt-ip>10.2.10.40</mgmt-ip>\n         <mgmt-ipv6>2001:db8:85a3::8a2e:370:7002</mgmt-ipv6>\n         <software-ver>20.01-179</software-ver>\n         <heartbeat1>ok</heartbeat1>\n         <heartbeat2>ok</heartbeat2>\n         <vpsa-chap-user>myvpsa</vpsa-chap-user>\n         <vpsa-chap-secret>L4Jx5xidZDEH</vpsa-chap-secret>\n         <host-chap-user />\n         <host-chap-secret />\n         <ike-psk>ABCE2144EDCD42259CF8C97D78F82BE3</ike-psk>\n         <encryption-password-set>0</encryption-password-set>\n         <is-encryption-active>0</is-encryption-active>\n         <sn-host>qa10-sn1</sn-host>\n         <cache-size type=\"integer\">20</cache-size>\n         <cpu-usage-alert type=\"integer\">95</cpu-usage-alert>\n         <mem-usage-alert type=\"integer\">90</mem-usage-alert>\n         <cpu-docker-usage-alert type=\"integer\">95</cpu-docker-usage-alert>\n         <mem-docker-usage-alert type=\"integer\">95</mem-docker-usage-alert>\n         <recycle-bin>YES</recycle-bin>\n         <dm-concurrency-level type=\"integer\">1</dm-concurrency-level>\n         <nfs4-disable-idmapping>YES</nfs4-disable-idmapping>\n         <raid-read-mode>round-robin</raid-read-mode>\n         <allocation-zone-name>zone_0</allocation-zone-name>\n         <allocation-zone-display-name>zone_0</allocation-zone-display-name>\n         <smb-unix-charset>UTF-8</smb-unix-charset>\n         <smb-dos-charset>CP850</smb-dos-charset>\n         <vpsa-uuid>B8A379E4051348BDA3BE4D1DC3BB24A6</vpsa-uuid>\n         <sod-end-time />\n         <wwpn-count type=\"integer\">0</wwpn-count>\n         <integrity-status>not-applicable</integrity-status>\n         <iser-support>YES</iser-support>\n      </vcontroller>\n      <vcontroller>\n         <name>vsa-00000038-vc-0</name>\n         <display-name>vsa-00000038-vc-0</display-name>\n         <index>0</index>\n         <state>active</state>\n         <target>iqn.2011-04.com.zadarastorage:vsa-00000038:1</target>\n         <iscsi-ip>10.2.10.27</iscsi-ip>\n         <iscsi-ipv6 />\n         <mgmt-ip>10.2.10.27</mgmt-ip>\n         <mgmt-ipv6 />\n         <software-ver>20.01-179</software-ver>\n         <heartbeat1>ok</heartbeat1>\n         <heartbeat2>ok</heartbeat2>\n         <vpsa-chap-user>myvpsa</vpsa-chap-user>\n         <vpsa-chap-secret>L4Jx5xidZDEH</vpsa-chap-secret>\n         <host-chap-user />\n         <host-chap-secret />\n         <ike-psk>ABCE2144EDCD42259CF8C97D78F82BE3</ike-psk>\n         <encryption-password-set>0</encryption-password-set>\n         <is-encryption-active>0</is-encryption-active>\n         <sn-host>qa10-sn5</sn-host>\n         <cache-size type=\"integer\">20</cache-size>\n         <cpu-usage-alert type=\"integer\">95</cpu-usage-alert>\n         <mem-usage-alert type=\"integer\">90</mem-usage-alert>\n         <cpu-docker-usage-alert type=\"integer\">95</cpu-docker-usage-alert>\n         <mem-docker-usage-alert type=\"integer\">95</mem-docker-usage-alert>\n         <recycle-bin>YES</recycle-bin>\n         <dm-concurrency-level type=\"integer\">1</dm-concurrency-level>\n         <nfs4-disable-idmapping>YES</nfs4-disable-idmapping>\n         <raid-read-mode>round-robin</raid-read-mode>\n         <allocation-zone-name>zone_0</allocation-zone-name>\n         <allocation-zone-display-name>zone_0</allocation-zone-display-name>\n         <smb-unix-charset>UTF-8</smb-unix-charset>\n         <smb-dos-charset>CP850</smb-dos-charset>\n         <vpsa-uuid>B8A379E4051348BDA3BE4D1DC3BB24A6</vpsa-uuid>\n         <sod-end-time>2020-01-26T08:46:25+0200</sod-end-time>\n         <wwpn-count type=\"integer\">0</wwpn-count>\n         <integrity-status>normal</integrity-status>\n         <iser-support>YES</iser-support>\n      </vcontroller>\n   </vcontrollers>\n</show-vcontrollers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"vcontrollers\": [\n      {\n        \"name\": \"vsa-00000038-vc-1\",\n        \"display_name\": \"vsa-00000038-vc-1\",\n        \"index\": \"1\",\n        \"state\": \"standby\",\n        \"target\": \"iqn.2011-04.com.zadarastorage:vsa-00000038:1\",\n        \"iscsi_ip\": \"3.112.112.2\",\n        \"iscsi_ipv6\": \"2001:db8:85a3::8a2e:370:7002\",\n        \"mgmt_ip\": \"10.2.10.40\",\n        \"mgmt_ipv6\": \"2001:db8:85a3::8a2e:370:7002\",\n        \"software_ver\": \"20.01-179\",\n        \"heartbeat1\": \"ok\",\n        \"heartbeat2\": \"ok\",\n        \"vpsa_chap_user\": \"myvpsa\",\n        \"vpsa_chap_secret\": \"L4Jx5xidZDEH\",\n        \"host_chap_user\": null,\n        \"host_chap_secret\": null,\n        \"ike_psk\": \"ABCE2144EDCD42259CF8C97D78F82BE3\",\n        \"encryption_password_set\": \"0\",\n        \"is_encryption_active\": \"0\",\n        \"sn_host\": \"qa10-sn1\",\n        \"cache_size\": 20,\n        \"cpu_usage_alert\": 95,\n        \"mem_usage_alert\": 90,\n        \"cpu_docker_usage_alert\": 95,\n        \"mem_docker_usage_alert\": 95,\n        \"recycle_bin\": \"YES\",\n        \"dm_concurrency_level\": 1,\n        \"nfs4_disable_idmapping\": \"YES\",\n        \"raid_read_mode\": \"round-robin\",\n        \"allocation_zone_name\": \"zone_0\",\n        \"allocation_zone_display_name\": \"zone_0\",\n        \"smb_unix_charset\": \"UTF-8\",\n        \"smb_dos_charset\": \"CP850\",\n        \"vpsa_uuid\": \"B8A379E4051348BDA3BE4D1DC3BB24A6\",\n        \"sod_end_time\": null,\n        \"wwpn_count\": 0,\n        \"integrity_status\": \"not-applicable\",\n        \"iser_support\": \"YES\"\n      },\n      {\n        \"name\": \"vsa-00000038-vc-0\",\n        \"display_name\": \"vsa-00000038-vc-0\",\n        \"index\": \"0\",\n        \"state\": \"active\",\n        \"target\": \"iqn.2011-04.com.zadarastorage:vsa-00000038:1\",\n        \"iscsi_ip\": \"10.2.10.27\",\n        \"iscsi_ipv6\": null,\n        \"mgmt_ip\": \"10.2.10.27\",\n        \"mgmt_ipv6\": null,\n        \"software_ver\": \"20.01-179\",\n        \"heartbeat1\": \"ok\",\n        \"heartbeat2\": \"ok\",\n        \"vpsa_chap_user\": \"myvpsa\",\n        \"vpsa_chap_secret\": \"L4Jx5xidZDEH\",\n        \"host_chap_user\": null,\n        \"host_chap_secret\": null,\n        \"ike_psk\": \"ABCE2144EDCD42259CF8C97D78F82BE3\",\n        \"encryption_password_set\": \"0\",\n        \"is_encryption_active\": \"0\",\n        \"sn_host\": \"qa10-sn5\",\n        \"cache_size\": 20,\n        \"cpu_usage_alert\": 95,\n        \"mem_usage_alert\": 90,\n        \"cpu_docker_usage_alert\": 95,\n        \"mem_docker_usage_alert\": 95,\n        \"recycle_bin\": \"YES\",\n        \"dm_concurrency_level\": 1,\n        \"nfs4_disable_idmapping\": \"YES\",\n        \"raid_read_mode\": \"round-robin\",\n        \"allocation_zone_name\": \"zone_0\",\n        \"allocation_zone_display_name\": \"zone_0\",\n        \"smb_unix_charset\": \"UTF-8\",\n        \"smb_dos_charset\": \"CP850\",\n        \"vpsa_uuid\": \"B8A379E4051348BDA3BE4D1DC3BB24A6\",\n        \"sod_end_time\": \"2020-01-26T08:46:25+0200\",\n        \"wwpn_count\": 0,\n        \"integrity_status\": \"normal\",\n        \"iser_support\": \"YES\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/vcontrollers/virtual_networks",
          "method": "GET",
          "description": "Get a list of Controller Virtual Networks.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-vnis-response>\n    <status type=\"integer\">0</status>\n    <vnis-count type=\"integer\">1</vnis-count>\n    <vnis type=\"array\">\n        <vni>\n          <id type=\"integer\">0</id>\n          <ip>10.213.44.2</ip>\n          <ipv6 />\n          <gateway>10.213.44.1</gateway>\n          <ipv6-gateway />\n          <netmask>255.255.255.252</netmask>\n          <ipv6-netmask />\n          <vlan-id type=\"integer\">62</vlan-id>\n          <interface>vni0</interface>\n          <net-uuid>13</net-uuid>\n        </vni>\n    </vnis>\n</show-vnis-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"vnis\": [\n      {\n        \"id\": 0,\n        \"ip\": \"10.213.44.2\",\n        \"ipv6\": null,\n        \"gateway\": \"10.213.44.1\",\n        \"ipv6_gateway\": null,\n        \"netmask\": \"255.255.255.252\",\n        \"ipv6_netmask\": null,\n        \"vlan_id\": 62,\n        \"interface\": \"vni0\",\n        \"net_uuid\": \"13\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/vcontrollers/failover",
          "method": "POST",
          "description": "Failover the active Controller.",
          "parameters": [
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<failover-vcontroller-response>\n    <status type=\"integer\">0</status>\n</failover-vcontroller-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/vcontrollers/{id}/sessions",
          "method": "GET",
          "description": "Lists vcontroller's sessions.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <count type=\"integer\">1</count>\n  <sessions type=\"array\">\n    <session>\n      <access-type>ISCSI</access-type>\n      <initiator>iqn.1991-05.com.microsoft:vm91-win2008r2.zadara.lab</initiator>\n      <target>iqn.test.com.zadarastorage:vsa-00000000:1</target>\n      <count type=\"integer\">1</count>\n      <vc type=\"integer\">0</vc>\n      <server-name>srv-00000003</server-name>\n      <server-display-name>VM91_WIN2008R2</server-display-name>\n    </session>\n  </sessions>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"sessions\": [\n      {\n        \"access_type\": \"ISCSI\",\n        \"initiator\": \"iqn.1991-05.com.microsoft:vm91-win2008r2.zadara.lab\",\n        \"target\": \"iqn.test.com.zadarastorage:vsa-00000000:1\",\n        \"count\": 1,\n        \"vc\": 0,\n        \"server_name\": \"srv-00000003\",\n        \"server_display_name\": \"VM91_WIN2008R2\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/vcontrollers/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "required": true,
              "description": "The interval between data points, in seconds.",
              "example": 1
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_vcontroller_perf-response>\n    <vcontroller-name>vsa-00000968-vc-0</vcontroller-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <cpu-user type=\"float\">20.000000</cpu-user>\n            <cpu-system type=\"float\">9.000000</cpu-system>\n            <cpu-iowait type=\"float\">0.000000</cpu-iowait>\n            <cpu-idle type=\"float\">71.000000</cpu-idle>\n            <mem-alloc type=\"float\">39.000000</mem-alloc>\n            <gb-wrt type=\"float\">0.000000</gb-wrt>\n            <gb-rd type=\"float\">0.000000</gb-rd>\n            <zcache-data-dirty type=\"float\">0.000000</zcache-data-dirty>\n            <zcache-meta-dirty type=\"float\">0.000000</zcache-meta-dirty>\n            <point type=\"integer\">1386985440</point>\n        </usage>\n        <usage>\n            <cpu-user type=\"float\">3.061224</cpu-user>\n            <cpu-system type=\"float\">1.020408</cpu-system>\n            <cpu-iowait type=\"float\">0.000000</cpu-iowait>\n            <cpu-idle type=\"float\">95.918367</cpu-idle>\n            <mem-alloc type=\"float\">39.000000</mem-alloc>\n            <gb-wrt type=\"float\">0.000000</gb-wrt>\n            <gb-rd type=\"float\">0.000000</gb-rd>\n            <zcache-data-dirty type=\"float\">0.000000</zcache-data-dirty>\n            <zcache-meta-dirty type=\"float\">0.000000</zcache-meta-dirty>\n            <point type=\"integer\">1386985441</point>\n        </usage>\n    </usages>\n</get_vcontroller_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vcontroller_name\": \"vsa-00000968-vc-0\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"cpu_user\": 20.0,\n        \"cpu_system\": 9.0,\n        \"cpu_iowait\": 0.0,\n        \"cpu_idle\": 71.0,\n        \"mem_alloc\": 39.0,\n        \"gb_wrt\": 0.0,\n        \"gb_rd\": 0.0,\n        \"zcache_data_dirty\": 0.0,\n        \"zcache_meta_dirty\": 0.0,\n        \"point\": 1386985440\n      },\n      {\n        \"cpu_user\": 3.061224,\n        \"cpu_system\": 1.020408,\n        \"cpu_iowait\": 0.0,\n        \"cpu_idle\": 95.918367,\n        \"mem_alloc\": 39.0,\n        \"gb_wrt\": 0.0,\n        \"gb_rd\": 0.0,\n        \"zcache_data_dirty\": 0.0,\n        \"zcache_meta_dirty\": 0.0,\n        \"point\": 1386985441\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/vcontrollers/{id}/cache_performance",
          "method": "GET",
          "productType": "hybrid",
          "description": "Returns the last 60 data points of cache performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "required": false,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_zcache_perf-response>\n    <zcache-name />\n    <status type=\"integer\">0</status>\n    <zcache-usages-count type=\"integer\">20</zcache-usages-count>\n    <zcache-usages type=\"array\">\n        <zcache-usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985536</point>\n        </zcache-usage>\n        <zcache-usage>\n            <rd-iops type=\"integer\">0</rd-iops>\n            <rd-iotime type=\"float\">0.000000</rd-iotime>\n            <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n            <rd-queue-len type=\"integer\">0</rd-queue-len>\n            <wrt-iops type=\"integer\">0</wrt-iops>\n            <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n            <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n            <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n            <point type=\"integer\">1386985537</point>\n        </zcache-usage>\n    </zcache-usages>\n</get_zcache_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"zcache_name\": null,\n    \"status\": 0,\n    \"zcache_usages\": [\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985536\n      },\n      {\n        \"rd_iops\": 0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"point\": 1386985537\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/vcontrollers/{id}/cache_stats",
          "method": "GET",
          "productType": "hybrid",
          "description": "Returns the last 60 data points of cache stats data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<get_zcache_stat-response>\n  <zcache-name></zcache-name>\n  <status type=\"integer\">0</status>\n  <usages-count type=\"integer\">20</usages-count>\n  <usages type=\"array\">\n    <usage>\n      <zcache-data-dirty type=\"float\">0.000000</zcache-data-dirty>\n      <zcache-meta-dirty type=\"float\">0.000000</zcache-meta-dirty>\n      <zcache-data-clean type=\"float\">0.000000</zcache-data-clean>\n      <zcache-meta-clean type=\"float\">0.000000</zcache-meta-clean>\n      <zcache-data-cb-util type=\"float\">0.000000</zcache-data-cb-util>\n      <zcache-meta-cb-util type=\"float\">96.000000</zcache-meta-cb-util>\n      <zcache-data-read-hit type=\"float\">0.000000</zcache-data-read-hit>\n      <zcache-meta-read-hit type=\"float\">0.000000</zcache-meta-read-hit>\n      <zcache-data-write-hit type=\"float\">0.000000</zcache-data-write-hit>\n      <zcache-meta-write-hit type=\"float\">0.000000</zcache-meta-write-hit>\n      <point type=\"integer\">1427966949</point>\n    </usage>\n    <usage>\n      <zcache-data-dirty type=\"float\">0.000000</zcache-data-dirty>\n      <zcache-meta-dirty type=\"float\">0.000000</zcache-meta-dirty>\n      <zcache-data-clean type=\"float\">0.000000</zcache-data-clean>\n      <zcache-meta-clean type=\"float\">0.000000</zcache-meta-clean>\n      <zcache-data-cb-util type=\"float\">0.000000</zcache-data-cb-util>\n      <zcache-meta-cb-util type=\"float\">96.000000</zcache-meta-cb-util>\n      <zcache-data-read-hit type=\"float\">0.000000</zcache-data-read-hit>\n      <zcache-meta-read-hit type=\"float\">0.000000</zcache-meta-read-hit>\n      <zcache-data-write-hit type=\"float\">0.000000</zcache-data-write-hit>\n      <zcache-meta-write-hit type=\"float\">0.000000</zcache-meta-write-hit>\n      <point type=\"integer\">1427966950</point>\n    </usage>\n  </usages>\n</get_zcache_stat-response>\n",
          "response_json": "{\n  \"response\": {\n    \"zcache_name\": null,\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"zcache_data_dirty\": 0.0,\n        \"zcache_meta_dirty\": 0.0,\n        \"zcache_data_clean\": 0.0,\n        \"zcache_meta_clean\": 0.0,\n        \"zcache_data_cb_util\": 0.0,\n        \"zcache_meta_cb_util\": 96.0,\n        \"zcache_data_read_hit\": 0.0,\n        \"zcache_meta_read_hit\": 0.0,\n        \"zcache_data_write_hit\": 0.0,\n        \"zcache_meta_write_hit\": 0.0,\n        \"point\": 1427966949\n      },\n      {\n        \"zcache_data_dirty\": 0.0,\n        \"zcache_meta_dirty\": 0.0,\n        \"zcache_data_clean\": 0.0,\n        \"zcache_meta_clean\": 0.0,\n        \"zcache_data_cb_util\": 0.0,\n        \"zcache_meta_cb_util\": 96.0,\n        \"zcache_data_read_hit\": 0.0,\n        \"zcache_meta_read_hit\": 0.0,\n        \"zcache_data_write_hit\": 0.0,\n        \"zcache_meta_write_hit\": 0.0,\n        \"point\": 1427966950\n      }\n    ],\n    \"count\": 20\n  }\n}"
        }
      ]
    },
    {
      "name": "Mirroring and Cloning",
      "description": "Operations for Remote Mirroring and Cloning.",
      "methods": [
        {
          "uri": "/mirror_jobs",
          "method": "GET",
          "description": "Show all Remote Mirror Jobs.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-vpsa-mirror-jobs-response>\n    <status type=\"integer\">0</status>\n    <vpsa-mirror-jobs-count type=\"integer\">1</vpsa-mirror-jobs-count>\n    <vpsa-mirror-jobs type=\"array\">\n        <vpsa-mirror-job>\n            <job-name>srcjvpsa-00000001</job-name>\n            <job-display-name>mirror</job-display-name>\n            <src>\n                <provider>openstack</provider>\n                <vpsa-display-name>myvpsa</vpsa-display-name>\n                <cg-display-name>volume</cg-display-name>\n                <cg-name>cg-00000001</cg-name>\n                <pool-display-name>poolrenamed</pool-display-name>\n            </src>\n            <dst>\n                <provider>openstack</provider>\n                <vpsa-display-name>myvpsa2</vpsa-display-name>\n                <cg-display-name>remotevolume</cg-display-name>\n                <cg-name />\n                <pool-display-name>pool</pool-display-name>\n            </dst>\n            <status>Idle</status>\n            <rpo>2013-09-27 02:10:20</rpo>\n            <wan-optimization>YES</wan-optimization>\n            <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n            <created-at type=\"datetime\">2013-09-27 02:09:38</created-at>\n            <modified-at type=\"datetime\">2013-09-27 02:10:21</modified-at>\n        </vpsa-mirror-job>\n    </vpsa-mirror-jobs>\n</show-vpsa-mirror-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"vpsa_mirror_jobs\": [\n      {\n        \"job_name\": \"srcjvpsa-00000001\",\n        \"job_display_name\": \"mirror\",\n        \"src\": {\n          \"provider\": \"openstack\",\n          \"vpsa_display_name\": \"myvpsa\",\n          \"cg_display_name\": \"volume\",\n          \"cg_name\": \"cg-00000001\",\n          \"pool_display_name\": \"poolrenamed\"\n        },\n        \"dst\": {\n          \"provider\": \"openstack\",\n          \"vpsa_display_name\": \"myvpsa2\",\n          \"cg_display_name\": \"remotevolume\",\n          \"cg_name\": null,\n          \"pool_display_name\": \"pool\"\n        },\n        \"status\": \"Idle\",\n        \"rpo\": \"2013-09-27 02:10:20\",\n        \"wan_optimization\": \"YES\",\n        \"avg_sync_rate_kb_sec\": \"0\",\n        \"created_at\": \"2013-09-27 02:09:38 UTC\",\n        \"modified_at\": \"2013-09-27 02:10:21 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}",
          "method": "GET",
          "description": "Show One Remote Mirror Jobs.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-vpsa-mirror-job-response>\n  <vpsa-mirror-job>\n      <job-name>srcjvpsa-00000001</job-name>\n      <job-display-name>mirror</job-display-name>\n      <src>\n          <provider>openstack</provider>\n          <vpsa-display-name>myvpsa</vpsa-display-name>\n          <cg-display-name>volume</cg-display-name>\n          <cg-name>cg-00000001</cg-name>\n          <pool-display-name>pool1</pool-display-name>\n      </src>\n      <dst>\n          <provider>openstack</provider>\n          <vpsa-display-name>myvpsa2</vpsa-display-name>\n          <cg-display-name>remotevolume</cg-display-name>\n          <cg-name />\n          <pool-display-name>pool2</pool-display-name>\n      </dst>\n      <status>Idle</status>\n      <rpo>2013-09-27 02:10:20</rpo>\n      <wan-optimization>YES</wan-optimization>\n      <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n      <created-at type=\"datetime\">2013-09-27 02:09:38</created-at>\n      <modified-at type=\"datetime\">2013-09-27 02:10:21</modified-at>\n  </vpsa-mirror-job>\n</show-one-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job\": {\n      \"job_name\": \"srcjvpsa-00000001\",\n      \"job_display_name\": \"mirror\",\n      \"src\": {\n        \"provider\": \"openstack\",\n        \"vpsa_display_name\": \"myvpsa\",\n        \"cg_display_name\": \"volume\",\n        \"cg_name\": \"cg-00000001\",\n        \"pool_display_name\": \"pool1\"\n      },\n      \"dst\": {\n        \"provider\": \"openstack\",\n        \"vpsa_display_name\": \"myvpsa2\",\n        \"cg_display_name\": \"remotevolume\",\n        \"cg_name\": null,\n        \"pool_display_name\": \"pool2\"\n      },\n      \"status\": \"Idle\",\n      \"rpo\": \"2013-09-27 02:10:20\",\n      \"wan_optimization\": \"YES\",\n      \"avg_sync_rate_kb_sec\": \"0\",\n      \"created_at\": \"2013-09-27 02:09:38 UTC\",\n      \"modified_at\": \"2013-09-27 02:10:21 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/pause",
          "method": "POST",
          "description": "Pause a Remote Mirror Job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-vpsa-mirror-job-response>\n    <vpsa-mirror-job-name>srcjvpsa-00000001</vpsa-mirror-job-name>\n    <status type=\"integer\">0</status>\n</pause-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/continue",
          "method": "POST",
          "description": "Continue a Paused Remote Mirror Job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<continue-vpsa-mirror-job-response>\n    <vpsa-mirror-job-name>srcjvpsa-00000001</vpsa-mirror-job-name>\n    <status type=\"integer\">0</status>\n</continue-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/break",
          "method": "POST",
          "description": "Breaks a Remote Mirror Job.",
          "parameters": [
            {
              "name": "inherited",
              "type": "string",
              "required": false,
              "options": "YES, NO",
              "description": "Assign source WWID to target volume. Relevant only for Block type volume.",
              "example": "NO"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<break-vpsa-mirror-job-response>\n    <vpsa-mirror-job-name>srcjvpsa-00000001</vpsa-mirror-job-name>\n    <status type=\"integer\">0</status>\n</break-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/rate_limit",
          "method": "POST",
          "description": "Update a mirror job rate limit (kb/s)",
          "parameters": [
            {
              "name": "limit",
              "type": "integer",
              "description": "Rate limit in kb/s",
              "example": 44
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-higher-rate-vpsa-mirror-job-response>\n  <vpsa-mirror-job-name>srcjvpsa-00000001</vpsa-mirror-job-name>\n  <status type=\"integer\">0</status>\n</set-higher-rate-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas",
          "method": "GET",
          "description": "List all Remote VPSAs.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-remote-vpsas-response>\n    <status type=\"integer\">0</status>\n    <remote-vpsas-count type=\"integer\">1</remote-vpsas-count>\n    <remote-vpsas type=\"array\">\n        <remote-vpsa>\n            <name>rvpsa-00000002</name>\n            <remote-name>vsa-000007bc</remote-name>\n            <remote-display-name>myvpsa2</remote-display-name>\n            <provider>openstack</provider>\n            <software-version>13.09-988-13</software-version>\n            <uuid>87461016365148A6A459152BA1E28222</uuid>\n            <ip>170.70.2.109</ip>\n            <public>NO</public>\n            <vni>vni0</vni>\n        </remote-vpsa>\n    </remote-vpsas>\n</show-remote-vpsas-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"remote_vpsas\": [\n      {\n        \"name\": \"rvpsa-00000002\",\n        \"remote_name\": \"vsa-000007bc\",\n        \"remote_display_name\": \"myvpsa2\",\n        \"provider\": \"openstack\",\n        \"software_version\": \"13.09-988-13\",\n        \"uuid\": \"87461016365148A6A459152BA1E28222\",\n        \"ip\": \"170.70.2.109\",\n        \"public\": \"NO\",\n        \"vni\": \"vni0\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/discover",
          "method": "POST",
          "description": "Discover and connect a Remote VPSA. Must supply User credentials of the remote VPSA and define if the discovery is done via a Public IP or the Management IP",
          "parameters": [
            {
              "name": "ip",
              "type": "string",
              "required": true,
              "description": "IP of VPSA to discover",
              "example": "11.22.33.44"
            },
            {
              "name": "user",
              "type": "string",
              "required": true,
              "description": "username of VPSA to discover",
              "example": "johndoe"
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "password of VPSA to discover",
              "example": "mysupersecretpassword"
            },
            {
              "name": "interface",
              "type": "string",
              "required": false,
              "options": "public, vni0, fe",
              "description": "Set interface to use for connecting the remote vpsa",
              "example": "public",
              "default": "fe"
            },
            {
              "name": "proxyhost",
              "type": "string",
              "required": false,
              "description": "If using proxy, the proxy host",
              "example": "11.22.33.44"
            },
            {
              "name": "proxyport",
              "type": "string",
              "required": false,
              "description": "If using proxy, the proxy port",
              "example": "88"
            },
            {
              "name": "proxytype",
              "type": "string",
              "required": false,
              "options": "http, http10, socks4_hostname, socks5, socks4, socks4a",
              "description": "If using proxy, the proxy type",
              "example": "http"
            },
            {
              "name": "proxyusername",
              "type": "string",
              "required": false,
              "description": "If using proxy with authentication, the proxy username",
              "example": "johndoe"
            },
            {
              "name": "proxypassword",
              "type": "string",
              "required": false,
              "description": "If using proxy with authentication, the proxy user password",
              "example": "mysupersecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<discover-remote-vpsa-response>\n    <remote-vpsa-name>rvpsa-00000001</remote-vpsa-name>\n    <status type=\"integer\">0</status>\n</discover-remote-vpsa-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_vpsa_name\": \"rvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}",
          "method": "GET",
          "description": "Get information about a single Remote VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-remote-vpsa-response>\n    <status type=\"integer\">0</status>\n    <remote-vpsa>\n        <name>rvpsa-00000002</name>\n        <remote-name>vsa-000007bc</remote-name>\n        <remote-display-name>myvpsa2</remote-display-name>\n        <provider>openstack</provider>\n        <software-version>13.09-988-13</software-version>\n        <uuid>87461016365148A6A459152BA1E28222</uuid>\n        <ip>170.70.2.109</ip>\n        <public>NO</public>\n        <vni>vni0</vni>\n    </remote-vpsa>\n</show-one-remote-vpsa-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"remote_vpsa\": {\n      \"name\": \"rvpsa-00000002\",\n      \"remote_name\": \"vsa-000007bc\",\n      \"remote_display_name\": \"myvpsa2\",\n      \"provider\": \"openstack\",\n      \"software_version\": \"13.09-988-13\",\n      \"uuid\": \"87461016365148A6A459152BA1E28222\",\n      \"ip\": \"170.70.2.109\",\n      \"public\": \"NO\",\n      \"vni\": \"vni0\"\n    }\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/refresh",
          "method": "POST",
          "description": "Refresh discovered data about a Remote VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<refresh-discovery-data-response>\n    <remote-vpsa-name>rvpsa-00000001</remote-vpsa-name>\n    <status type=\"integer\">0</status>\n</refresh-discovery-data-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_vpsa_name\": \"rvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}",
          "method": "DELETE",
          "description": "Delete the local record of a Remote VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-remote-vpsa-response>\n    <remote-vpsa-name>rvpsa-00000001</remote-vpsa-name>\n    <status type=\"integer\">0</status>\n</delete-remote-vpsa-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_vpsa_name\": \"rvpsa-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/pools",
          "method": "GET",
          "description": "List the Pools in a Remote VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-remote-pools-in-remote-vpsa-response>\n    <remote-vpsa-name>rvpsa-00000002</remote-vpsa-name>\n    <status type=\"integer\">0</status>\n    <remote-pools-count type=\"integer\">1</remote-pools-count>\n    <remote-pools type=\"array\">\n        <remote-pool>\n            <name>rpool-00000002</name>\n            <remote-display-name>pool</remote-display-name>\n            <capacity>133</capacity>\n            <free-capacity>129</free-capacity>\n            <mode>simple</mode>\n            <stripe-size>64</stripe-size>\n            <version>2</version>\n        </remote-pool>\n    </remote-pools>\n</show-remote-pools-in-remote-vpsa-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_vpsa_name\": \"rvpsa-00000002\",\n    \"status\": 0,\n    \"remote_pools\": [\n      {\n        \"name\": \"rpool-00000002\",\n        \"remote_display_name\": \"pool\",\n        \"capacity\": \"133\",\n        \"free_capacity\": \"129\",\n        \"mode\": \"simple\",\n        \"stripe_size\": \"64\",\n        \"version\": \"2\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/suggested_jobs",
          "method": "GET",
          "description": "List Volumes on the remote VPSA which are candidates for resuming Remote Mirroring relationship. Typically, those Volumes were part of a mirror relationship in the past and still have a snapshots that correlates to an existing snapshot in the local VPSA. Those identical snapshots will be used to resume mirroring relationship",
          "parameters": [
            {
              "name": "cgname",
              "type": "string",
              "required": true,
              "description": "CG ID for the local Volume.",
              "example": "cg-00000001"
            },
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get-dst-job-for-resume-response>\n    <status type=\"integer\">0</status>\n    <sugested-jobs-count type=\"integer\">1</sugested-jobs-count>\n    <sugested-jobs type=\"array\">\n        <sugested-job>\n            <dst-cg-name>cg-00000001</dst-cg-name>\n            <dst-cg-display-name>remotevolume</dst-cg-display-name>\n            <dst-snap-name>snap-00000001</dst-snap-name>\n            <dst-snap-display-name>s-r3-1380240620852</dst-snap-display-name>\n            <src-snap-name>snap-00000003</src-snap-name>\n            <src-snap-display-name>s-r3-1380240620852</src-snap-display-name>\n            <sync-at type=\"datetime\">2013-09-27 02:10:20</sync-at>\n            <snaps-todelete type=\"integer\">0</snaps-todelete>\n            <dst-data-changed>NO</dst-data-changed>\n        </sugested-job>\n    </sugested-jobs>\n</get-dst-job-for-resume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"sugested_jobs\": [\n      {\n        \"dst_cg_name\": \"cg-00000001\",\n        \"dst_cg_display_name\": \"remotevolume\",\n        \"dst_snap_name\": \"snap-00000001\",\n        \"dst_snap_display_name\": \"s-r3-1380240620852\",\n        \"src_snap_name\": \"snap-00000003\",\n        \"src_snap_display_name\": \"s-r3-1380240620852\",\n        \"sync_at\": \"2013-09-27 02:10:20 UTC\",\n        \"snaps_todelete\": 0,\n        \"dst_data_changed\": \"NO\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/resume_mirror_job",
          "method": "POST",
          "description": "Resume a Remote Mirroring relationship between a local Volume snapshot and an remote Volume Snapshot on the remote VPSA",
          "parameters": [
            {
              "name": "displayname",
              "type": "string",
              "required": true,
              "description": "Display name for resumed mirror.",
              "example": "my-mirror"
            },
            {
              "name": "policy",
              "type": "string",
              "required": true,
              "description": "Policy ID",
              "example": "policy-00000001"
            },
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable Dedupe For Mirror."
            },
            {
              "name": "compress",
              "type": "string",
              "options": "YES, NO",
              "productType": "AFA",
              "example": "YES",
              "description": "Enable Compression For Mirror."
            },
            {
              "name": "wanoptimization",
              "type": "string",
              "required": true,
              "description": "enable WAN optimization.",
              "options": "YES, NO",
              "example": "YES"
            },
            {
              "name": "snapname",
              "type": "string",
              "required": true,
              "description": "The local Snapshot ID.",
              "example": "snap-00000001"
            },
            {
              "name": "remote_snapname",
              "type": "string",
              "description": "ID of a Remote Snapshot to resume from.",
              "required": true,
              "example": "snap-00000003"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<resume-vpsa-mirror-job-response>\n    <vpsa-mirror-job-name>srcjvpsa-00000002</vpsa-mirror-job-name>\n    <status type=\"integer\">0</status>\n</resume-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vpsa_mirror_job_name\": \"srcjvpsa-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/rate_limit",
          "method": "POST",
          "description": "Update a remote vpsa rate limit (kb/s)",
          "parameters": [
            {
              "name": "limit",
              "type": "integer",
              "description": "Rate limit in kb/s",
              "example": 44
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-remote-vpsa-response>\n  <remote-vpsa-name>rvpsa-00000002</remote-vpsa-name>\n  <status type=\"integer\">0</status>\n</update-remote-vpsa-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_vpsa_name\": \"rvpsa-00000002\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/consistency_groups/{jobname}/attach_snapshot_policy",
          "method": "POST",
          "description": "Attach a Snapshot Policy to a Volume.",
          "parameters": [
            {
              "name": "policyname",
              "type": "string",
              "description": "A policy ID.",
              "required": true,
              "example": "policy-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<attach-snapshot-policy-to-vpsa-mirror-job-response>\n    <snapshot-rule-name>rule-0000000f</snapshot-rule-name>\n    <status type=\"integer\">0</status>\n</attach-snapshot-policy-to-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_rule_name\": \"rule-0000000f\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{job-id}/detach_snapshot_policy",
          "method": "POST",
          "description": "Detach a Snapshot Policy from a Mirror job.",
          "parameters": [
            {
              "name": "snaprule",
              "type": "string",
              "description": "A snaprule ID.",
              "required": true,
              "example": "rule-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<detach-snapshot-policy-from-vpsa-mirror-job-response>\n    <snapshot-rule-name>rule-0000000d</snapshot-rule-name>\n    <status type=\"integer\">0</status>\n</detach-snapshot-policy-from-vpsa-mirror-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_rule_name\": \"rule-0000000d\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/set_wan_optimization",
          "method": "POST",
          "description": "Update a Mirror's WAN optimization.",
          "parameters": [
            {
              "name": "wan_optimization",
              "type": "string",
              "options": "YES, NO",
              "example": "NO"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-vpsa-mirror-job-wan-optimization-response>\n    <status type=\"integer\">0</status>\n</set-vpsa-mirror-job-wan-optimization-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/snapshots",
          "method": "GET",
          "description": "Get all snapshots created by a mirror job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-snapshots-on-cg-response>\n    <status type=\"integer\">0</status>\n    <snapshots-count type=\"integer\">1</snapshots-count>\n    <snapshots type=\"array\">\n        <snapshot>\n            <name>snap-00000d2b</name>\n            <display-name>s-ra-1505204453226</display-name>\n            <status>normal</status>\n            <cg-display-name>c</cg-display-name>\n            <cg-name>cg-00000001</cg-name>\n            <pool-name>pool-00000001</pool-name>\n            <created-at type=\"datetime\">2017-09-12T11:20:53+0300</created-at>\n            <modified-at type=\"datetime\">2017-09-12T11:20:53+0300</modified-at>\n            <volume-ext-name>volume-00000001</volume-ext-name>\n            <volume-display-name>v1</volume-display-name>\n            <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n        </snapshot>\n    </snapshots>\n</show-snapshots-on-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshots\": [\n      {\n        \"name\": \"snap-00000d2b\",\n        \"display_name\": \"s-ra-1505204453226\",\n        \"status\": \"normal\",\n        \"cg_display_name\": \"c\",\n        \"cg_name\": \"cg-00000001\",\n        \"pool_name\": \"pool-00000001\",\n        \"created_at\": \"2017-09-12 08:20:53 UTC\",\n        \"modified_at\": \"2017-09-12 08:20:53 UTC\",\n        \"volume_ext_name\": \"volume-00000001\",\n        \"volume_display_name\": \"v1\",\n        \"volume_capacity_mb\": 102400\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/mirror_jobs/{id}/clone_snapshot",
          "method": "POST",
          "description": "Clone a mirror job's snapshot into a volume.",
          "parameters": [
            {
              "name": "snapshot",
              "type": "string",
              "description": "A snapshot's id.",
              "required": true,
              "example": "snap-00000d63"
            },
            {
              "name": "clone_name",
              "type": "string",
              "description": "The name for the new volume.",
              "required": true,
              "example": "cloned_volume"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<clone-cg-response>\n    <cg-name>cg-00000008</cg-name>\n    <status type=\"integer\">0</status>\n</clone-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"cg_name\": \"cg-00000008\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/volumes",
          "method": "GET",
          "description": "List the Volumes in a Remote VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-remote-cgs-response>\n  <status type=\"integer\">0</status>\n  <cgs-count type=\"integer\">1</cgs-count>\n  <cgs type=\"array\">\n    <cg>\n      <name>cg-00000001</name>\n      <display-name>blk1</display-name>\n      <volume-name>volume-00000001</volume-name>\n      <data-type>BLOCK</data-type>\n      <provisioned-capacity type=\"integer\">1111</provisioned-capacity>\n      <encryption>NO</encryption>\n    </cg>\n  </cgs>\n</show-remote-cgs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"cgs\": [\n      {\n        \"name\": \"cg-00000001\",\n        \"display_name\": \"blk1\",\n        \"volume_name\": \"volume-00000001\",\n        \"data_type\": \"BLOCK\",\n        \"provisioned_capacity\": 1111,\n        \"encryption\": \"NO\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/remote_vpsas/{id}/snapshots",
          "method": "GET",
          "description": "List the snapshots in a Remote VPSA volume.",
          "parameters": [
            {
              "name": "cgname",
              "type": "string",
              "description": "cg name.",
              "required": true,
              "example": "cg-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-remote-snapshots-on-cg-response>\n  <status type=\"integer\">0</status>\n  <snapshots-count type=\"integer\">3</snapshots-count>\n  <snapshots type=\"array\">\n    <snapshot>\n      <name>snap-0000005b</name>\n      <display-name>clone</display-name>\n      <created-at-utc type=\"datetime\">2019-05-12T08:45:38+0000</created-at-utc>\n      <volume-ext-name>volume-00000001</volume-ext-name>\n      <volume-display-name>v1</volume-display-name>\n      <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n    </snapshot>\n    <snapshot>\n      <name>snap-0000005f</name>\n      <display-name>s-r2-1557670832606</display-name>\n      <created-at-utc type=\"datetime\">2019-05-12T14:20:32+0000</created-at-utc>\n      <volume-ext-name>volume-00000002</volume-ext-name>\n      <volume-display-name>v2</volume-display-name>\n      <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n    </snapshot>\n    <snapshot>\n      <name>snap-00000060</name>\n      <display-name>s-r2-1557676845955</display-name>\n      <created-at-utc type=\"datetime\">2019-05-12T16:00:45+0000</created-at-utc>\n      <volume-ext-name>volume-00000003</volume-ext-name>\n      <volume-display-name>v3</volume-display-name>\n      <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n    </snapshot>\n  </snapshots>\n</show-remote-snapshots-on-cg-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshots\": [\n      {\n        \"name\": \"snap-0000005b\",\n        \"display_name\": \"clone\",\n        \"created_at_utc\": \"2019-05-12 08:45:38 UTC\",\n        \"volume_ext_name\": \"volume-00000001\",\n        \"volume_display_name\": \"v1\",\n        \"volume_capacity_mb\": 102400\n      },\n      {\n        \"name\": \"snap-0000005f\",\n        \"display_name\": \"s-r2-1557670832606\",\n        \"created_at_utc\": \"2019-05-12 14:20:32 UTC\",\n        \"volume_ext_name\": \"volume-00000002\",\n        \"volume_display_name\": \"v2\",\n        \"volume_capacity_mb\": 102400\n      },\n      {\n        \"name\": \"snap-00000060\",\n        \"display_name\": \"s-r2-1557676845955\",\n        \"created_at_utc\": \"2019-05-12 16:00:45 UTC\",\n        \"volume_ext_name\": \"volume-00000003\",\n        \"volume_display_name\": \"v3\",\n        \"volume_capacity_mb\": 102400\n      }\n    ],\n    \"count\": 3\n  }\n}"
        },
        {
          "uri": "/volumes/remote_clone",
          "method": "POST",
          "description": "Create a Remote Clone.",
          "parameters": [
            {
              "name": "displayname",
              "type": "string",
              "required": true,
              "description": "The new remote clone name",
              "example": "my-volume"
            },
            {
              "name": "volname",
              "type": "string",
              "required": true,
              "description": "Destination volume name",
              "example": "my-volume"
            },
            {
              "name": "poolname",
              "type": "string",
              "required": true,
              "description": "Pool to create remote clone",
              "example": "pool-00010001"
            },
            {
              "name": "remote_clone_mode",
              "type": "string",
              "required": true,
              "description": "Remote Clone mode",
              "options": "clone|retrieve",
              "example": "clone"
            },
            {
              "name": "vpsaname",
              "type": "string",
              "required": true,
              "description": "The source vpsa name",
              "example": "rvpsa-00000002"
            },
            {
              "name": "snapname",
              "type": "string",
              "required": true,
              "description": "The source snapshot name",
              "example": "snap-0000005f"
            },
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "productType": "AFA",
              "example": "YES",
              "description": "Enable Dedupe For Remote Clone."
            },
            {
              "name": "compress",
              "type": "string",
              "productType": "AFA",
              "options": "YES, NO",
              "example": "YES",
              "description": "Enable compress For Remote Clone."
            },
            {
              "name": "crypt",
              "type": "string",
              "options": "YES, NO",
              "description": "Enable encryption for this Remote Clone."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-volume-response>\n    <vol-name>volume-00000001</vol-name>\n    <status type=\"integer\">0</status>\n</create-volume-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_clones",
          "method": "GET",
          "description": "List the VPSA Remote Clones.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-remote-clone-jobs-response>\n  <status type=\"integer\">0</status>\n  <remote-clone-jobs-count type=\"integer\">1</remote-clone-jobs-count>\n  <remote-clone-jobs type=\"array\">\n    <remote-clone-job>\n      <job-name>dstrclone-00000004</job-name>\n      <job-display-name>cloned</job-display-name>\n      <mode>Clone</mode>\n      <comment/>\n      <src>\n        <provider>zadaratest1</provider>\n        <vpsa-display-name>testvpsa</vpsa-display-name>\n        <vpsa-uuid>81441176117A46DEB6C48253C321DD89</vpsa-uuid>\n        <snap-display-name>clone</snap-display-name>\n        <snap-name>snap-0000005b</snap-name>\n        <volume-name/>\n        <volume-display-name/>\n      </src>\n      <dst>\n        <provider>zadaratest1</provider>\n        <vpsa-display-name>testvpsa2</vpsa-display-name>\n        <vpsa-uuid>20DB8067FC5B45C79DB2C39F3CFF93F0</vpsa-uuid>\n        <cg-display-name>cloned</cg-display-name>\n        <cg-name>cg-00000005</cg-name>\n      </dst>\n      <status>Syncing</status>\n      <compress>YES</compress>\n      <dedupe>YES</dedupe>\n      <created-at type=\"datetime\">2019-05-12T11:47:14+0300</created-at>\n      <modified-at type=\"datetime\">2019-05-12T11:50:34+0300</modified-at>\n    </remote-clone-job>\n  </remote-clone-jobs>\n</show-remote-clone-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"remote_clone_jobs\": [\n      {\n        \"job_name\": \"dstrclone-00000004\",\n        \"job_display_name\": \"cloned\",\n        \"mode\": \"Clone\",\n        \"comment\": null,\n        \"src\": {\n          \"provider\": \"zadaratest1\",\n          \"vpsa_display_name\": \"testvpsa\",\n          \"vpsa_uuid\": \"81441176117A46DEB6C48253C321DD89\",\n          \"snap_display_name\": \"clone\",\n          \"snap_name\": \"snap-0000005b\",\n          \"volume_name\": null,\n          \"volume_display_name\": null\n        },\n        \"dst\": {\n          \"provider\": \"zadaratest1\",\n          \"vpsa_display_name\": \"testvpsa2\",\n          \"vpsa_uuid\": \"20DB8067FC5B45C79DB2C39F3CFF93F0\",\n          \"cg_display_name\": \"cloned\",\n          \"cg_name\": \"cg-00000005\"\n        },\n        \"status\": \"Syncing\",\n        \"compress\": \"YES\",\n        \"dedupe\": \"YES\",\n        \"created_at\": \"2019-05-12 08:47:14 UTC\",\n        \"modified_at\": \"2019-05-12 08:50:34 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/remote_clones/{id}",
          "method": "GET",
          "description": "Show a Remote Clone.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-remote-clone-job-response>\n  <status type=\"integer\">0</status>\n  <remote-clone-job>\n    <job-name>dstrclone-00000004</job-name>\n    <job-display-name>cloned</job-display-name>\n    <mode>Clone</mode>\n    <comment/>\n    <src>\n      <provider>zadaratest1</provider>\n      <vpsa-display-name>testvpsa</vpsa-display-name>\n      <vpsa-uuid>81441176117A46DEB6C48253C321DD89</vpsa-uuid>\n      <snap-display-name>clone</snap-display-name>\n      <snap-name>snap-0000005b</snap-name>\n      <volume-name/>\n      <volume-display-name/>\n    </src>\n    <dst>\n      <provider>zadaratest1</provider>\n      <vpsa-display-name>testvpsa2</vpsa-display-name>\n      <vpsa-uuid>20DB8067FC5B45C79DB2C39F3CFF93F0</vpsa-uuid>\n      <cg-display-name>cloned</cg-display-name>\n      <cg-name>cg-00000005</cg-name>\n    </dst>\n    <status>Syncing</status>\n    <compress>YES</compress>\n    <dedupe>YES</dedupe>\n    <created-at type=\"datetime\">2019-05-12T11:47:14+0300</created-at>\n    <modified-at type=\"datetime\">2019-05-12T11:50:34+0300</modified-at>\n  </remote-clone-job>\n</show-one-remote-clone-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"remote_clone_job\": {\n      \"job_name\": \"dstrclone-00000004\",\n      \"job_display_name\": \"cloned\",\n      \"mode\": \"Clone\",\n      \"comment\": null,\n      \"src\": {\n        \"provider\": \"zadaratest1\",\n        \"vpsa_display_name\": \"testvpsa\",\n        \"vpsa_uuid\": \"81441176117A46DEB6C48253C321DD89\",\n        \"snap_display_name\": \"clone\",\n        \"snap_name\": \"snap-0000005b\",\n        \"volume_name\": null,\n        \"volume_display_name\": null\n      },\n      \"dst\": {\n        \"provider\": \"zadaratest1\",\n        \"vpsa_display_name\": \"testvpsa2\",\n        \"vpsa_uuid\": \"20DB8067FC5B45C79DB2C39F3CFF93F0\",\n        \"cg_display_name\": \"cloned\",\n        \"cg_name\": \"cg-00000005\"\n      },\n      \"status\": \"Syncing\",\n      \"compress\": \"YES\",\n      \"dedupe\": \"YES\",\n      \"created_at\": \"2019-05-12 08:47:14 UTC\",\n      \"modified_at\": \"2019-05-12 08:50:34 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/remote_clones/{id}/pause",
          "method": "POST",
          "description": "Pause a Remote Clone Job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-remote-clone-job-response>\n  <remote-clone-job-name>dstrclone-00000004</remote-clone-job-name>\n  <status type=\"integer\">0</status>\n</pause-remote-clone-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_clone_job_name\": \"dstrclone-00000004\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_clones/{id}/continue",
          "method": "POST",
          "description": "Continue a Paused Remote Clone Job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-remote-clone-job-response>\n  <remote-clone-job-name>dstrclone-00000004</remote-clone-job-name>\n  <status type=\"integer\">0</status>\n</pause-remote-clone-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_clone_job_name\": \"dstrclone-00000004\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_clones/{id}/break",
          "method": "POST",
          "description": "Breaks a Remote Clone Job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<break-remote-clone-job-response>\n  <remote-clone-job-name>dstrclone-00000004</remote-clone-job-name>\n  <status type=\"integer\">0</status>\n</break-remote-clone-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_clone_job_name\": \"dstrclone-00000004\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/remote_clones/{id}/switch_mode",
          "method": "POST",
          "description": "Switch a Remote Clone Job clone mode.",
          "parameters": [
            {
              "name": "mode",
              "type": "string",
              "description": "Remote clone mode.",
              "required": true,
              "options": "clone, retrieve",
              "example": "clone"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<change-remote-clone-job-mode-response>\n  <remote-clone-job-name>dstrclone-00000005</remote-clone-job-name>\n  <status type=\"integer\">0</status>\n</change-remote-clone-job-mode-response>\n",
          "response_json": "{\n  \"response\": {\n    \"remote_clone_job_name\": \"dstrclone-00000005\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Remote object storage",
      "description": "Operations for Remote Object Storages.",
      "methods": [
        {
          "uri": "/object_storage_destinations",
          "method": "GET",
          "description": "List all remote object storages.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<show-obs-destinations-response>\n  <status type=\"integer\">0</status>\n  <obs-destinations-count type=\"integer\">1</obs-destinations-count>\n  <obs-destinations type=\"array\">\n    <obs-destination>\n      <name>obsdst-00000001</name>\n      <display-name>AWS-s3.amazonaws.com-mybucket</display-name>\n      <type>AWS_S3</type>\n      <endpoint>s3.amazonaws.com</endpoint>\n      <region>us-east-1</region>\n      <aws-auth-method>V2</aws-auth-method>\n      <bucket>mybucket</bucket>\n      <allow-lifecycle-policies>NO</allow-lifecycle-policies>\n      <ip>iSCSI IP</ip>\n    </obs-destination>\n  </obs-destinations>\n</show-obs-destinations-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destinations\": [\n      {\n        \"name\": \"obsdst-00000001\",\n        \"display_name\": \"AWS-s3.amazonaws.com-mybucket\",\n        \"type\": \"AWS_S3\",\n        \"endpoint\": \"s3.amazonaws.com\",\n        \"region\": \"us-east-1\",\n        \"aws_auth_method\": \"V2\",\n        \"bucket\": \"mybucket\",\n        \"allow_lifecycle_policies\": \"NO\",\n        \"ip\": \"iSCSI IP\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}",
          "method": "GET",
          "description": "List all Remote object storages.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<show-one-obs-destination-response>\n  <status type=\"integer\">0</status>\n  <obs-destination>\n    <name>obsdst-00000001</name>\n    <display-name>AWS-s3.amazonaws.com-zadarastorage-eyal-us</display-name>\n    <type>AWS_S3</type>\n    <endpoint>s3.amazonaws.com</endpoint>\n    <region>us-east-1</region>\n    <aws-auth-method>V2</aws-auth-method>\n    <bucket>zadarastorage-eyal-us</bucket>\n    <allow-lifecycle-policies>NO</allow-lifecycle-policies>\n    <ip>iSCSI IP</ip>\n  </obs-destination>\n</show-one-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination\": {\n      \"name\": \"obsdst-00000001\",\n      \"display_name\": \"AWS-s3.amazonaws.com-zadarastorage-eyal-us\",\n      \"type\": \"AWS_S3\",\n      \"endpoint\": \"s3.amazonaws.com\",\n      \"region\": \"us-east-1\",\n      \"aws_auth_method\": \"V2\",\n      \"bucket\": \"zadarastorage-eyal-us\",\n      \"allow_lifecycle_policies\": \"NO\",\n      \"ip\": \"iSCSI IP\"\n    }\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations",
          "method": "POST",
          "description": "Create a remote object storage.",
          "parameters": [
            {
              "name": "name",
              "description": "Display Name for remote object storage",
              "type": "string",
              "required": true,
              "example": "remote object storage 1"
            },
            {
              "name": "type",
              "description": "Type for remote object storage",
              "type": "string",
              "options": "AWS_S3 | GCS_S3 | ZIOS_S3",
              "required": true,
              "example": "AWS_S3"
            },
            {
              "name": "bucket",
              "description": "remote object storage bucket name",
              "type": "string",
              "required": true,
              "example": "my bucket"
            },
            {
              "name": "endpoint",
              "description": "Endpoint for remote object storage (use 'storage.googleapis.com' for Google cloud).",
              "type": "string",
              "required": true,
              "example": "s3-eu-west-1.amazonaws.com"
            },
            {
              "name": "username",
              "description": "Access Key ID for remote object storage",
              "type": "string",
              "required": true,
              "example": "mys3username"
            },
            {
              "name": "password",
              "description": "Secret Access Key for remote object storage",
              "type": "string",
              "required": true,
              "example": "mys3password"
            },
            {
              "name": "connectVia",
              "description": "Connection method for remote object storage",
              "type": "string",
              "options": "be | public",
              "required": true,
              "example": "public"
            },
            {
              "name": "allow_lifecycle_policies",
              "description": "Allow bucket to have lifecycle policies (Valid Only for AWS)",
              "type": "boolean"
            },
            {
              "name": "proxyhost",
              "description": "Proxy host",
              "type": "string",
              "example": "10.10.10.10"
            },
            {
              "name": "proxyport",
              "description": "Port for proxy",
              "type": "string",
              "example": 7878
            },
            {
              "name": "proxyuser",
              "description": "Username for proxy",
              "type": "string",
              "example": "user"
            },
            {
              "name": "proxypassword",
              "description": "Password for proxy",
              "type": "string",
              "example": "password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-obs-destination-response>\n  <status type=\"integer\">0</status>\n  <obs-destination-name>obsdst-00000003</obs-destination-name>\n</update-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination_name\": \"obsdst-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations",
          "method": "POST",
          "description": "Create a remote object storage in Azure cloud.",
          "parameters": [
            {
              "name": "name",
              "description": "Display Name for remote object storage",
              "type": "string",
              "required": true,
              "example": "remote object storage 1"
            },
            {
              "name": "type",
              "description": "Type for remote object storage - use 'AZURE'.",
              "type": "string",
              "options": "AZURE",
              "required": true,
              "example": "AZURE"
            },
            {
              "name": "bucket",
              "description": "Azure cloud container name.",
              "type": "string",
              "required": true,
              "example": "my container"
            },
            {
              "name": "endpoint",
              "description": "Endpoint for Azure cloud - use 'blob.core.windows.net'.",
              "options": "blob.core.windows.net",
              "type": "string",
              "required": true,
              "example": "blob.core.windows.net"
            },
            {
              "name": "username",
              "description": "Account in Azure cloud.",
              "type": "string",
              "required": true,
              "example": "my_azure_account"
            },
            {
              "name": "password",
              "description": "Storage account key in Azure cloud.",
              "type": "string",
              "required": true,
              "example": "my_azure_account_key"
            },
            {
              "name": "connectVia",
              "description": "Connection method to Azure cloud.",
              "type": "string",
              "options": "be | public",
              "required": true,
              "example": "public"
            },
            {
              "name": "allow_lifecycle_policies",
              "description": "Allow bucket to have lifecycle policies - use 'true'.",
              "required": true,
              "options": "true",
              "type": "boolean"
            },
            {
              "name": "proxyhost",
              "description": "Proxy host",
              "type": "string",
              "example": "10.10.10.10"
            },
            {
              "name": "proxyport",
              "description": "Port for proxy",
              "type": "string",
              "example": 7878
            },
            {
              "name": "proxyuser",
              "description": "Username for proxy",
              "type": "string",
              "example": "user"
            },
            {
              "name": "proxypassword",
              "description": "Password for proxy",
              "type": "string",
              "example": "password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-obs-destination-response>\n  <status type=\"integer\">0</status>\n  <obs-destination-name>obsdst-00000003</obs-destination-name>\n</update-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination_name\": \"obsdst-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}",
          "method": "PUT",
          "description": "Update a remote object storage.",
          "parameters": [
            {
              "name": "bucket",
              "description": "remote object storage bucket name",
              "type": "string",
              "example": "my bucket"
            },
            {
              "name": "endpoint",
              "description": "Endpoint for remote object storage",
              "type": "string",
              "example": "s3-eu-west-1.amazonaws.com"
            },
            {
              "name": "username",
              "description": "Access Key ID for remote object storage",
              "type": "string",
              "example": "mys3username"
            },
            {
              "name": "password",
              "description": "Secret Access Key for remote object storage",
              "type": "string",
              "example": "mys3password"
            },
            {
              "name": "connectVia",
              "description": "Connection method for remote object storage",
              "type": "string",
              "options": "be | public",
              "example": "public"
            },
            {
              "name": "allow_lifecycle_policies",
              "description": "Allow bucket to have lifecycke policies (Valid Only for AWS)",
              "type": "boolean"
            },
            {
              "name": "proxyhost",
              "description": "Proxy host",
              "type": "string",
              "example": "10.10.10.10"
            },
            {
              "name": "proxyport",
              "description": "Port for proxy",
              "type": "string",
              "example": 7878
            },
            {
              "name": "proxyuser",
              "description": "Username for proxy",
              "type": "string",
              "example": "user"
            },
            {
              "name": "proxypassword",
              "description": "Password for proxy",
              "type": "string",
              "example": "password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-obs-destination-response>\n  <status type=\"integer\">0</status>\n  <obs-destination-name>obsdst-00000003</obs-destination-name>\n</update-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination_name\": \"obsdst-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}",
          "method": "PUT",
          "description": "Update an Azure cloud remote object storage.",
          "parameters": [
            {
              "name": "bucket",
              "description": "Azure cloud container name.",
              "type": "string",
              "example": "my container"
            },
            {
              "name": "username",
              "description": "Account in Azure cloud.",
              "type": "string",
              "example": "my_azure_account"
            },
            {
              "name": "password",
              "description": "Storage account key in Azure cloud.",
              "type": "string",
              "example": "my_azure_account_key"
            },
            {
              "name": "connectVia",
              "description": "Connection method to Azure cloud.",
              "type": "string",
              "options": "be | public",
              "example": "public"
            },
            {
              "name": "proxyhost",
              "description": "Proxy host",
              "type": "string",
              "example": "10.10.10.10"
            },
            {
              "name": "proxyport",
              "description": "Port for proxy",
              "type": "string",
              "example": 7878
            },
            {
              "name": "proxyuser",
              "description": "Username for proxy",
              "type": "string",
              "example": "user"
            },
            {
              "name": "proxypassword",
              "description": "Password for proxy",
              "type": "string",
              "example": "password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<update-obs-destination-response>\n  <status type=\"integer\">0</status>\n  <obs-destination-name>obsdst-00000003</obs-destination-name>\n</update-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination_name\": \"obsdst-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}",
          "method": "DELETE",
          "description": "Delete a remote object storage.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<delete-obs-destination-response>\n    <status type=\"integer\">0</status>\n    <obs-destination-name>obsdst-00000003</obs-destination-name>\n</delete-obs-destination-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_destination_name\": \"obsdst-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}/backup_jobs",
          "method": "GET",
          "description": "Show object storage destination backup jobs.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-obs-backup-jobs-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-jobs-count type=\"integer\">1</obs-backup-jobs-count>\n  <obs-backup-jobs type=\"array\">\n    <obs-backup-job>\n      <name>bkpjobs-00000005</name>\n      <display-name>bkpjob</display-name>\n      <status>Idle</status>\n      <compression>YES</compression>\n      <rpo>2015-05-25T17:22:03+0300</rpo>\n      <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n      <created-at type=\"datetime\">2015-05-25T17:21:27+0300</created-at>\n      <modified-at type=\"datetime\">2015-05-25T17:22:38+0300</modified-at>\n      <src>\n        <cg-name>cg-00000003</cg-name>\n        <cg-display-name>fdgdfg</cg-display-name>\n        <pool-name>pool-00000001</pool-name>\n        <pool-display-name>pool1</pool-display-name>\n      </src>\n      <dst>\n        <type>AWS_S3</type>\n        <region>us-east-1</region>\n        <endpoint>s3.amazonaws.com</endpoint>\n        <bucket>zadarastorage-eyal-us</bucket>\n      </dst>\n      <snapshot-policy>\n        <name>policy-00000003</name>\n        <display-name>Daily Snapshots for a Week</display-name>\n        <create-policy>0 0 * * *</create-policy>\n        <delete-policy>N7</delete-policy>\n        <destination-delete-policy>N7</destination-delete-policy>\n        <paused>NO</paused>\n        <create-empty>NO</create-empty>\n        <attach>YES</attach>\n      </snapshot-policy>\n    </obs-backup-job>\n  </obs-backup-jobs>\n</show-obs-backup-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_jobs\": [\n      {\n        \"name\": \"bkpjobs-00000005\",\n        \"display_name\": \"bkpjob\",\n        \"status\": \"Idle\",\n        \"compression\": \"YES\",\n        \"rpo\": \"2015-05-25T17:22:03+0300\",\n        \"avg_sync_rate_kb_sec\": \"0\",\n        \"created_at\": \"2015-05-25 14:21:27 UTC\",\n        \"modified_at\": \"2015-05-25 14:22:38 UTC\",\n        \"src\": {\n          \"cg_name\": \"cg-00000003\",\n          \"cg_display_name\": \"fdgdfg\",\n          \"pool_name\": \"pool-00000001\",\n          \"pool_display_name\": \"pool1\"\n        },\n        \"dst\": {\n          \"type\": \"AWS_S3\",\n          \"region\": \"us-east-1\",\n          \"endpoint\": \"s3.amazonaws.com\",\n          \"bucket\": \"zadarastorage-eyal-us\"\n        },\n        \"snapshot_policy\": {\n          \"name\": \"policy-00000003\",\n          \"display_name\": \"Daily Snapshots for a Week\",\n          \"create_policy\": \"0 0 * * *\",\n          \"delete_policy\": \"N7\",\n          \"destination_delete_policy\": \"N7\",\n          \"paused\": \"NO\",\n          \"create_empty\": \"NO\",\n          \"attach\": \"YES\"\n        }\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/object_storage_destinations/{id}/restore_jobs",
          "method": "GET",
          "description": "Show object storage destination restore jobs.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-obs-restore-jobs-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-jobs-count type=\"integer\">1</obs-restore-jobs-count>\n  <obs-restore-jobs type=\"array\">\n    <obs-restore-job>\n      <name>rstjobs-00000001</name>\n      <display-name>restore_job_obssnap-00000008</display-name>\n      <mode>Restore</mode>\n      <obs-key>...</obs-key>\n      <status>Creating VPSA volume</status>\n      <rpo>2015-05-25T17:22:03+0300</rpo>\n      <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n      <cur-sync-rate-kb-sec>0</cur-sync-rate-kb-sec>\n      <shipping-position-mb type=\"integer\">0</shipping-position-mb>\n      <total-capacity-mb>63</total-capacity-mb>\n      <already-restored-mb type=\"integer\">0</already-restored-mb>\n      <remaining-time-sec type=\"integer\">N/A</remaining-time-sec>\n      <created-at type=\"datetime\">2015-05-26T11:13:58+0300</created-at>\n      <modified-at type=\"datetime\">2015-05-26T11:13:59+0300</modified-at>\n      <src>\n        <type>AWS_S3</type>\n        <region>us-east-1</region>\n        <endpoint>s3.amazonaws.com</endpoint>\n        <bucket>...</bucket>\n      </src>\n      <dst>\n        <cg-name>cg-0000000a</cg-name>\n        <cg-display-name>vol1</cg-display-name>\n        <pool-name>pool-00000001</pool-name>\n        <pool-display-name>pool1</pool-display-name>\n      </dst>\n    </obs-restore-job>\n  </obs-restore-jobs>\n</show-obs-restore-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_jobs\": [\n      {\n        \"name\": \"rstjobs-00000001\",\n        \"display_name\": \"restore_job_obssnap-00000008\",\n        \"mode\": \"Restore\",\n        \"obs_key\": \"...\",\n        \"status\": \"Creating VPSA volume\",\n        \"rpo\": \"2015-05-25T17:22:03+0300\",\n        \"avg_sync_rate_kb_sec\": \"0\",\n        \"cur_sync_rate_kb_sec\": \"0\",\n        \"shipping_position_mb\": 0,\n        \"total_capacity_mb\": \"63\",\n        \"already_restored_mb\": 0,\n        \"remaining_time_sec\": 0,\n        \"created_at\": \"2015-05-26 08:13:58 UTC\",\n        \"modified_at\": \"2015-05-26 08:13:59 UTC\",\n        \"src\": {\n          \"type\": \"AWS_S3\",\n          \"region\": \"us-east-1\",\n          \"endpoint\": \"s3.amazonaws.com\",\n          \"bucket\": \"...\"\n        },\n        \"dst\": {\n          \"cg_name\": \"cg-0000000a\",\n          \"cg_display_name\": \"vol1\",\n          \"pool_name\": \"pool-00000001\",\n          \"pool_display_name\": \"pool1\"\n        }\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs",
          "method": "GET",
          "description": "List all object storage backup jobs.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-obs-backup-jobs-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-jobs-count type=\"integer\">1</obs-backup-jobs-count>\n  <obs-backup-jobs type=\"array\">\n    <obs-backup-job>\n      <name>bkpjobs-00000005</name>\n      <display-name>ghfghfghfg</display-name>\n      <status>Idle</status>\n      <compression>YES</compression>\n      <rpo>2015-05-25T17:22:03+0300</rpo>\n      <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n      <created-at type=\"datetime\">2015-05-25T17:21:27+0300</created-at>\n      <modified-at type=\"datetime\">2015-05-25T17:22:38+0300</modified-at>\n      <src>\n        <cg-name>cg-00000003</cg-name>\n        <cg-display-name>fdgdfg</cg-display-name>\n        <pool-name>pool-00000001</pool-name>\n        <pool-display-name>pool1</pool-display-name>\n      </src>\n      <dst>\n        <type>AWS_S3</type>\n        <region>us-east-1</region>\n        <endpoint>s3.amazonaws.com</endpoint>\n        <bucket>mybucket</bucket>\n      </dst>\n      <snapshot-policy>\n        <name>policy-00000003</name>\n        <display-name>Daily Snapshots for a Week</display-name>\n        <create-policy>0 0 * * *</create-policy>\n        <delete-policy>N7</delete-policy>\n        <destination-delete-policy>N7</destination-delete-policy>\n        <paused>NO</paused>\n        <create-empty>NO</create-empty>\n        <attach>YES</attach>\n      </snapshot-policy>\n    </obs-backup-job>\n  </obs-backup-jobs>\n</show-obs-backup-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_jobs\": [\n      {\n        \"name\": \"bkpjobs-00000005\",\n        \"display_name\": \"ghfghfghfg\",\n        \"status\": \"Idle\",\n        \"compression\": \"YES\",\n        \"rpo\": \"2015-05-25T17:22:03+0300\",\n        \"avg_sync_rate_kb_sec\": \"0\",\n        \"created_at\": \"2015-05-25 14:21:27 UTC\",\n        \"modified_at\": \"2015-05-25 14:22:38 UTC\",\n        \"src\": {\n          \"cg_name\": \"cg-00000003\",\n          \"cg_display_name\": \"fdgdfg\",\n          \"pool_name\": \"pool-00000001\",\n          \"pool_display_name\": \"pool1\"\n        },\n        \"dst\": {\n          \"type\": \"AWS_S3\",\n          \"region\": \"us-east-1\",\n          \"endpoint\": \"s3.amazonaws.com\",\n          \"bucket\": \"mybucket\"\n        },\n        \"snapshot_policy\": {\n          \"name\": \"policy-00000003\",\n          \"display_name\": \"Daily Snapshots for a Week\",\n          \"create_policy\": \"0 0 * * *\",\n          \"delete_policy\": \"N7\",\n          \"destination_delete_policy\": \"N7\",\n          \"paused\": \"NO\",\n          \"create_empty\": \"NO\",\n          \"attach\": \"YES\"\n        }\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}",
          "method": "GET",
          "description": "List one object storage backup job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job>\n    <name>bkpjobs-00000005</name>\n    <display-name>ghfghfghfg</display-name>\n    <status>Idle</status>\n    <compression>YES</compression>\n    <rpo>2015-05-25T17:22:03+0300</rpo>\n    <avg-sync-rate-kb-sec>0</avg-sync-rate-kb-sec>\n    <created-at type=\"datetime\">2015-05-25T17:21:27+0300</created-at>\n    <modified-at type=\"datetime\">2015-05-25T17:22:38+0300</modified-at>\n    <src>\n      <cg-name>cg-00000003</cg-name>\n      <cg-display-name>fdgdfg</cg-display-name>\n      <pool-name>pool-00000001</pool-name>\n      <pool-display-name>pool1</pool-display-name>\n    </src>\n    <dst>\n      <type>AWS_S3</type>\n      <region>us-east-1</region>\n      <endpoint>s3.amazonaws.com</endpoint>\n      <bucket>zadarastorage-eyal-us</bucket>\n    </dst>\n    <snapshot-policy>\n      <name>policy-00000003</name>\n      <display-name>Daily Snapshots for a Week</display-name>\n      <create-policy>0 0 * * *</create-policy>\n      <delete-policy>N7</delete-policy>\n      <destination-delete-policy>N7</destination-delete-policy>\n      <paused>NO</paused>\n      <create-empty>NO</create-empty>\n      <attach>YES</attach>\n    </snapshot-policy>\n  </obs-backup-job>\n</show-one-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job\": {\n      \"name\": \"bkpjobs-00000005\",\n      \"display_name\": \"ghfghfghfg\",\n      \"status\": \"Idle\",\n      \"compression\": \"YES\",\n      \"rpo\": \"2015-05-25T17:22:03+0300\",\n      \"avg_sync_rate_kb_sec\": \"0\",\n      \"created_at\": \"2015-05-25 14:21:27 UTC\",\n      \"modified_at\": \"2015-05-25 14:22:38 UTC\",\n      \"src\": {\n        \"cg_name\": \"cg-00000003\",\n        \"cg_display_name\": \"fdgdfg\",\n        \"pool_name\": \"pool-00000001\",\n        \"pool_display_name\": \"pool1\"\n      },\n      \"dst\": {\n        \"type\": \"AWS_S3\",\n        \"region\": \"us-east-1\",\n        \"endpoint\": \"s3.amazonaws.com\",\n        \"bucket\": \"zadarastorage-eyal-us\"\n      },\n      \"snapshot_policy\": {\n        \"name\": \"policy-00000003\",\n        \"display_name\": \"Daily Snapshots for a Week\",\n        \"create_policy\": \"0 0 * * *\",\n        \"delete_policy\": \"N7\",\n        \"destination_delete_policy\": \"N7\",\n        \"paused\": \"NO\",\n        \"create_empty\": \"NO\",\n        \"attach\": \"YES\"\n      }\n    }\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs",
          "method": "POST",
          "description": "Create object storage backup job.",
          "parameters": [
            {
              "name": "name",
              "description": "Display Name for object storage backup job",
              "type": "string",
              "required": true,
              "example": "test"
            },
            {
              "name": "destination",
              "description": "Object storage destination for the backup",
              "type": "string",
              "required": true,
              "example": "obsdst-00000001"
            },
            {
              "name": "volume",
              "description": "Volume to backup",
              "type": "string",
              "required": true,
              "example": "volume-00000001"
            },
            {
              "name": "policy",
              "description": "snapshot policy for backup",
              "type": "string",
              "required": true,
              "example": "policy-00000001"
            },
            {
              "name": "compression",
              "description": "enable compression",
              "type": "string",
              "required": true,
              "options": "YES | NO",
              "example": "YES"
            },
            {
              "name": "sse",
              "type": "string",
              "required": true,
              "options": "NO | AES256 | KMS | KMSKEYID",
              "example": "AES256"
            },
            {
              "name": "storage_class",
              "description": "S3 storage class if the object storage destination is AWS S3. default is what configured on the bucket.",
              "type": "string",
              "required": false,
              "options": "STANDARD | INTELLIGENT_TIERING | STANDARD_IA",
              "example": "STANDARD"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</create-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs",
          "method": "POST",
          "description": "Create Azure cloud object storage backup job.",
          "parameters": [
            {
              "name": "name",
              "description": "Display Name for object storage backup job",
              "type": "string",
              "required": true,
              "example": "test"
            },
            {
              "name": "destination",
              "description": "Object storage destination for the backup",
              "type": "string",
              "required": true,
              "example": "obsdst-00000001"
            },
            {
              "name": "volume",
              "description": "Volume to backup",
              "type": "string",
              "required": true,
              "example": "volume-00000001"
            },
            {
              "name": "policy",
              "description": "snapshot policy for backup",
              "type": "string",
              "required": true,
              "example": "policy-00000001"
            },
            {
              "name": "compression",
              "description": "enable compression",
              "type": "string",
              "required": true,
              "options": "YES | NO",
              "example": "YES"
            },
            {
              "name": "sse",
              "description": "SSE - use 'NO'",
              "type": "string",
              "required": true,
              "options": "NO",
              "example": "NO"
            },
            {
              "name": "storage_class",
              "description": "BLOB storage tier.",
              "type": "string",
              "required": false,
              "options": "HOT | COOL",
              "example": "COOL"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</create-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/pause",
          "method": "POST",
          "description": "Pause object storage backup job.",
          "parameters": null,
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<pause-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</pause-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/update_storage_class",
          "method": "POST",
          "description": "Update a object storage backup job S3 storage class. only if Object storage destination is AWS S3.",
          "parameters": [
            {
              "name": "storage_class",
              "description": "new S3 storage class.",
              "type": "string",
              "options": "STANDARD | INTELLIGENT_TIERING | STANDARD_IA",
              "example": "STANDARD"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-obs-backup-job-storage-class-response>\n        <obs-backup-job-name>bkpjobs-00000005</obs-backup-job-name>\n        <status type=\"integer\">0</status>\n</set-obs-backup-job-storage-class-response>\n",
          "response_json": "{\n  \"response\": {\n    \"obs_backup_job_name\": \"bkpjobs-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/continue",
          "method": "POST",
          "description": "Continue object storage backup job.",
          "parameters": null,
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<continue-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</continue-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/break",
          "method": "POST",
          "description": "Break object storage backup job.",
          "parameters": [
            {
              "name": "purge_data",
              "type": "string",
              "options": "YES | NO",
              "required": true,
              "example": "YES"
            },
            {
              "name": "delete_snaphots",
              "type": "string",
              "options": "YES | NO",
              "required": true,
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<break-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</break-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/compression",
          "method": "POST",
          "description": "Set compression for object storage backup job.",
          "parameters": [
            {
              "name": "compression",
              "description": "enable compression",
              "type": "string",
              "options": "YES | NO",
              "required": true,
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<compression-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</compression-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/rate_limit",
          "method": "POST",
          "description": "Update a object storage backup job rate limit (kb/s)",
          "parameters": [
            {
              "name": "limit",
              "type": "integer",
              "description": "Rate limit in kb/s",
              "example": 44
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-obs-backup-job-higher-rate-response>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n  <status type=\"integer\">0</status>\n</set-obs-backup-job-higher-rate-response>\n",
          "response_json": "{\n  \"response\": {\n    \"obs_backup_job_name\": \"bkpjobs-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/replace_snapshot_policy",
          "method": "POST",
          "description": "Replace snapshot policy for object storage backup job.",
          "parameters": [
            {
              "name": "policyname",
              "description": "New policy Id",
              "type": "string",
              "required": true,
              "example": "policy-00000003"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<replace-snapshot-policy-obs-backup-job-response>\n  <status type=\"integer\">0</status>\n  <obs-backup-job-name>bkpjobs-00000003</obs-backup-job-name>\n</replace-snapshot-policy-obs-backup-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_backup_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_backup_jobs/{id}/performance",
          "method": "GET",
          "description": "Show object storage backup job performance.",
          "parameters": [
            {
              "name": "interval",
              "description": "Interval in seconds between metered data",
              "type": "string",
              "example": 1
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<get_obsbackup_datamover_perf-response>\n  <status type=\"integer\">0</status>\n  <usages-count type=\"integer\">20</usages-count>\n  <usages type=\"array\">\n    <usage>\n      <rd-iops type=\"float\">0.000000</rd-iops>\n      <rd-iotime type=\"float\">0.000000</rd-iotime>\n      <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n      <rd-queue-len type=\"integer\">0</rd-queue-len>\n      <wrt-iops type=\"float\">0.000000</wrt-iops>\n      <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n      <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n      <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n      <time>2015-07-01T11:45:24+0300</time>\n    </usage>\n    <usage>\n      <rd-iops type=\"float\">0.000000</rd-iops>\n      <rd-iotime type=\"float\">0.000000</rd-iotime>\n      <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n      <rd-queue-len type=\"integer\">0</rd-queue-len>\n      <wrt-iops type=\"float\">0.000000</wrt-iops>\n      <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n      <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n      <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n      <time>2015-07-01T11:45:25+0300</time>\n    </usage>\n  </usages>\n</get_obsbackup_datamover_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0.0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0.0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"time\": \"2015-07-01T11:45:24+0300\"\n      },\n      {\n        \"rd_iops\": 0.0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0.0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"time\": \"2015-07-01T11:45:25+0300\"\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs",
          "method": "GET",
          "description": "List all object storage restore jobs.",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-obs-restore-jobs-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-jobs-count type=\"integer\">2</obs-restore-jobs-count>\n  <obs-restore-jobs type=\"array\">\n    <obs-restore-job>\n      <name>rstjobs-00000003</name>\n      <display-name>restore_job_obssnap-00000001</display-name>\n      <mode>Clone</mode>\n      <obs-key>zadaratest.C97E9A00ADE7489BB08A9AB3B0B6484F/test1.vsa-0000015f/testvol.volume-00000002/2025-05-28T11:40:37+0000_snap-00000003</obs-key>\n      <status>Normal</status>\n      <rpo>2015-05-28T14:40:37+0300</rpo>\n      <avg-sync-rate-kb-sec></avg-sync-rate-kb-sec>\n      <cur-sync-rate-kb-sec></cur-sync-rate-kb-sec>\n      <shipping-position-mb type=\"integer\">0</shipping-position-mb>\n      <total-capacity-mb>13</total-capacity-mb>\n      <already-restored-mb type=\"integer\">0</already-restored-mb>\n      <remaining-time-sec type=\"integer\">N/A</remaining-time-sec>\n      <created-at type=\"datetime\">2015-05-28T14:59:01+0300</created-at>\n      <modified-at type=\"datetime\">2015-05-28T14:59:08+0300</modified-at>\n      <src>\n        <type>AWS_S3</type>\n        <region>us-east-1</region>\n        <endpoint>s3.amazonaws.com</endpoint>\n        <bucket>zadarastorage-test</bucket>\n      </src>\n      <dst>\n        <cg-name>cg-00000005</cg-name>\n        <cg-display-name>vol1</cg-display-name>\n        <pool-name>pool-00000001</pool-name>\n        <pool-display-name>pool1</pool-display-name>\n      </dst>\n    </obs-restore-job>\n  </obs-restore-jobs>\n</show-obs-restore-jobs-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_jobs\": [\n      {\n        \"name\": \"rstjobs-00000003\",\n        \"display_name\": \"restore_job_obssnap-00000001\",\n        \"mode\": \"Clone\",\n        \"obs_key\": \"zadaratest.C97E9A00ADE7489BB08A9AB3B0B6484F/test1.vsa-0000015f/testvol.volume-00000002/2025-05-28T11:40:37+0000_snap-00000003\",\n        \"status\": \"Normal\",\n        \"rpo\": \"2015-05-28T14:40:37+0300\",\n        \"avg_sync_rate_kb_sec\": null,\n        \"cur_sync_rate_kb_sec\": null,\n        \"shipping_position_mb\": 0,\n        \"total_capacity_mb\": \"13\",\n        \"already_restored_mb\": 0,\n        \"remaining_time_sec\": 0,\n        \"created_at\": \"2015-05-28 11:59:01 UTC\",\n        \"modified_at\": \"2015-05-28 11:59:08 UTC\",\n        \"src\": {\n          \"type\": \"AWS_S3\",\n          \"region\": \"us-east-1\",\n          \"endpoint\": \"s3.amazonaws.com\",\n          \"bucket\": \"zadarastorage-test\"\n        },\n        \"dst\": {\n          \"cg_name\": \"cg-00000005\",\n          \"cg_display_name\": \"vol1\",\n          \"pool_name\": \"pool-00000001\",\n          \"pool_display_name\": \"pool1\"\n        }\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}",
          "method": "GET",
          "description": "List one Object Storage restore job.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-obs-restore-job-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-job>\n    <name>rstjobs-00000003</name>\n    <display-name>restore_job_obssnap-00000001</display-name>\n    <mode>Clone</mode>\n    <obs-key>zadaratest.C97E9A00ADE7489BB08A9AB3B0B6484F/test1.vsa-0000015f/testvol.volume-00000002/2025-05-28T11:40:37+0000_snap-00000003</obs-key>\n    <status>Normal</status>\n    <rpo>2015-05-28T14:40:37+0300</rpo>\n    <avg-sync-rate-kb-sec></avg-sync-rate-kb-sec>\n    <cur-sync-rate-kb-sec></cur-sync-rate-kb-sec>\n    <shipping-position-mb type=\"integer\">0</shipping-position-mb>\n    <total-capacity-mb>13</total-capacity-mb>\n    <already-restored-mb type=\"integer\">0</already-restored-mb>\n    <remaining-time-sec type=\"integer\">N/A</remaining-time-sec>\n    <created-at type=\"datetime\">2015-05-28T14:59:01+0300</created-at>\n    <modified-at type=\"datetime\">2015-05-28T14:59:08+0300</modified-at>\n    <src>\n      <type>AWS_S3</type>\n      <region>us-east-1</region>\n      <endpoint>s3.amazonaws.com</endpoint>\n      <bucket>zadarastorage-test</bucket>\n    </src>\n    <dst>\n      <cg-name>cg-00000005</cg-name>\n      <cg-display-name>vol1</cg-display-name>\n      <pool-name>pool-00000001</pool-name>\n      <pool-display-name>pool1</pool-display-name>\n    </dst>\n  </obs-restore-job>\n</show-one-obs-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_job\": {\n      \"name\": \"rstjobs-00000003\",\n      \"display_name\": \"restore_job_obssnap-00000001\",\n      \"mode\": \"Clone\",\n      \"obs_key\": \"zadaratest.C97E9A00ADE7489BB08A9AB3B0B6484F/test1.vsa-0000015f/testvol.volume-00000002/2025-05-28T11:40:37+0000_snap-00000003\",\n      \"status\": \"Normal\",\n      \"rpo\": \"2015-05-28T14:40:37+0300\",\n      \"avg_sync_rate_kb_sec\": null,\n      \"cur_sync_rate_kb_sec\": null,\n      \"shipping_position_mb\": 0,\n      \"total_capacity_mb\": \"13\",\n      \"already_restored_mb\": 0,\n      \"remaining_time_sec\": 0,\n      \"created_at\": \"2015-05-28 11:59:01 UTC\",\n      \"modified_at\": \"2015-05-28 11:59:08 UTC\",\n      \"src\": {\n        \"type\": \"AWS_S3\",\n        \"region\": \"us-east-1\",\n        \"endpoint\": \"s3.amazonaws.com\",\n        \"bucket\": \"zadarastorage-test\"\n      },\n      \"dst\": {\n        \"cg_name\": \"cg-00000005\",\n        \"cg_display_name\": \"vol1\",\n        \"pool_name\": \"pool-00000001\",\n        \"pool_display_name\": \"pool1\"\n      }\n    }\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs",
          "method": "POST",
          "description": "Create object storage restore job.\n Can be created from object storage key or from object storage snapshot name\n (key or local_snapname must be supplied)\n",
          "parameters": [
            {
              "name": "name",
              "description": "Display Name for object storage restore job",
              "type": "string",
              "example": "test"
            },
            {
              "name": "mode",
              "description": "mode",
              "type": "string",
              "required": true,
              "example": "restore",
              "options": "restore|clone|import_seed"
            },
            {
              "name": "poolname",
              "description": "Id of created volume's destination pool",
              "type": "string",
              "required": true,
              "example": "pool-00000001"
            },
            {
              "name": "volname",
              "description": "Name of Created Volume",
              "type": "string",
              "required": true,
              "example": "cloned volume"
            },
            {
              "name": "remote_object_store",
              "description": "Id of object storage destination",
              "type": "string",
              "required": true,
              "example": "obsdst-00000001"
            },
            {
              "name": "key",
              "description": "Object storage key from bucket",
              "type": "string",
              "required": false,
              "example": "cloud1.C97E9A00ADE7489BB08A9AB3B0B6484F/myvpsa.vsa-00000169/myvol.volume-00000011/2015-07-01T09:26:01+0000_snap-0000003e/"
            },
            {
              "name": "local_snapname",
              "description": "Object storage local snapshot name",
              "type": "string",
              "required": false
            },
            {
              "name": "crypt",
              "description": "Enable encryption on volume",
              "type": "string",
              "options": "YES | NO",
              "required": false
            },
            {
              "name": "dedupe",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable Dedupe For Restore Job."
            },
            {
              "name": "compress",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "productType": "AFA",
              "description": "Enable compress or Restore Job."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-restore-job-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-job-name>bkpjobs-00000003</obs-restore-job-name>\n</create-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}/pause",
          "method": "POST",
          "description": "Pause object storage restore job.",
          "parameters": null,
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pause-obs-restore-job-response>\n  <obs-restore-job-name>rstjobs-0000001b</obs-restore-job-name>\n  <status type=\"integer\">12051</status>\n</pause-obs-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"obs_restore_job_name\": \"rstjobs-0000001b\",\n    \"status\": 12051\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}/continue",
          "method": "POST",
          "description": "Continue object storage restore job.",
          "parameters": null,
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<continue-restore-job-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-job-name>bkpjobs-00000003</obs-restore-job-name>\n</continue-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}/break",
          "method": "POST",
          "description": "Break object storage restore job.",
          "parameters": null,
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<break-restore-job-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-job-name>bkpjobs-00000003</obs-restore-job-name>\n</break-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}/switch_mode",
          "method": "POST",
          "description": "Set restore mode for object storage restore job.",
          "parameters": [
            {
              "name": "mode",
              "description": "Mode to switch to",
              "type": "string",
              "options": "clone|restore",
              "required": true,
              "example": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<switch-mode-restore-job-response>\n  <status type=\"integer\">0</status>\n  <obs-restore-job-name>bkpjobs-00000003</obs-restore-job-name>\n</switch-mode-restore-job-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"obs_restore_job_name\": \"bkpjobs-00000003\"\n  }\n}"
        },
        {
          "uri": "/object_storage_restore_jobs/{id}/performance",
          "method": "GET",
          "description": "Show object storage restore job performance.",
          "parameters": [
            {
              "name": "interval",
              "description": "Interval in seconds between metered data",
              "type": "string",
              "example": 1
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_obsrestore_datamover_perf-response>\n  <status type=\"integer\">0</status>\n  <usages-count type=\"integer\">20</usages-count>\n  <usages type=\"array\">\n    <usage>\n      <rd-iops type=\"float\">0.000000</rd-iops>\n      <rd-iotime type=\"float\">0.000000</rd-iotime>\n      <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n      <rd-queue-len type=\"integer\">0</rd-queue-len>\n      <wrt-iops type=\"float\">0.000000</wrt-iops>\n      <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n      <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n      <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n      <time>2015-07-01T14:13:26+0300</time>\n    </usage>\n    <usage>\n      <rd-iops type=\"float\">0.000000</rd-iops>\n      <rd-iotime type=\"float\">0.000000</rd-iotime>\n      <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n      <rd-queue-len type=\"integer\">0</rd-queue-len>\n      <wrt-iops type=\"float\">0.000000</wrt-iops>\n      <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n      <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n      <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n      <time>2015-07-01T14:13:27+0300</time>\n    </usage>\n    <usage>\n      <rd-iops type=\"float\">0.000000</rd-iops>\n      <rd-iotime type=\"float\">0.000000</rd-iotime>\n      <rd-bandwidth type=\"float\">0.000000</rd-bandwidth>\n      <rd-queue-len type=\"integer\">0</rd-queue-len>\n      <wrt-iops type=\"float\">0.000000</wrt-iops>\n      <wrt-iotime type=\"float\">0.000000</wrt-iotime>\n      <wrt-bandwidth type=\"float\">0.000000</wrt-bandwidth>\n      <wrt-queue-len type=\"integer\">0</wrt-queue-len>\n      <time>2015-07-01T14:13:28+0300</time>\n    </usage>\n  </usages>\n</get_obsrestore_datamover_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"rd_iops\": 0.0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0.0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"time\": \"2015-07-01T14:13:26+0300\"\n      },\n      {\n        \"rd_iops\": 0.0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0.0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"time\": \"2015-07-01T14:13:27+0300\"\n      },\n      {\n        \"rd_iops\": 0.0,\n        \"rd_iotime\": 0.0,\n        \"rd_bandwidth\": 0.0,\n        \"rd_queue_len\": 0,\n        \"wrt_iops\": 0.0,\n        \"wrt_iotime\": 0.0,\n        \"wrt_bandwidth\": 0.0,\n        \"wrt_queue_len\": 0,\n        \"time\": \"2015-07-01T14:13:28+0300\"\n      }\n    ],\n    \"count\": 20\n  }\n}"
        }
      ]
    },
    {
      "name": "Images",
      "description": "Operations involving Images.",
      "methods": [
        {
          "uri": "/images",
          "method": "GET",
          "description": "Returns a list of all images.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-images-response>\n    <status type=\"integer\">0</status>\n    <images-count type=\"integer\">4</images-count>\n    <images type=\"array\">\n        <image>\n          <name>img-00000001</name>\n          <display-name>nginx</display-name>\n          <status>normal</status>\n          <is-layered>True</is-layered>\n          <docker-id>a785ba7493fd9009be71023045790697f334486b11a45f7e830652d39665a451</docker-id>\n          <license-state type=\"integer\">0</license-state>\n          <capacity-mb type=\"integer\">126</capacity-mb>\n          <repository>nginx</repository>\n          <tag>latest</tag>\n          <volume-id type=\"integer\">1</volume-id>\n          <created-at type=\"datetime\">2015-06-11T08:47:28+0300</created-at>\n          <modified-at type=\"datetime\">2015-06-11T08:48:36+0300</modified-at>\n        </image>\n        <image>\n          <name>img-00000002</name>\n          <display-name>mysql</display-name>\n          <status>normal</status>\n          <is-layered>True</is-layered>\n          <docker-id>fa81ed084842076d1b39b56d084d99ec0011cd4a5ade1056be359486a8b213e4</docker-id>\n          <license-state type=\"integer\">0</license-state>\n          <capacity-mb type=\"integer\">179</capacity-mb>\n          <repository>ubuntu</repository>\n          <tag>latest</tag>\n          <volume-id type=\"integer\">1</volume-id>\n          <created-at type=\"datetime\">2015-06-11T11:23:47+0300</created-at>\n          <modified-at type=\"datetime\">2015-06-11T11:25:05+0300</modified-at>\n        </image>\n    </images>\n</show-images-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"images\": [\n      {\n        \"name\": \"img-00000001\",\n        \"display_name\": \"nginx\",\n        \"status\": \"normal\",\n        \"is_layered\": \"True\",\n        \"docker_id\": \"a785ba7493fd9009be71023045790697f334486b11a45f7e830652d39665a451\",\n        \"license_state\": 0,\n        \"capacity_mb\": 126,\n        \"repository\": \"nginx\",\n        \"tag\": \"latest\",\n        \"volume_id\": 1,\n        \"created_at\": \"2015-06-11 05:47:28 UTC\",\n        \"modified_at\": \"2015-06-11 05:48:36 UTC\"\n      },\n      {\n        \"name\": \"img-00000002\",\n        \"display_name\": \"mysql\",\n        \"status\": \"normal\",\n        \"is_layered\": \"True\",\n        \"docker_id\": \"fa81ed084842076d1b39b56d084d99ec0011cd4a5ade1056be359486a8b213e4\",\n        \"license_state\": 0,\n        \"capacity_mb\": 179,\n        \"repository\": \"ubuntu\",\n        \"tag\": \"latest\",\n        \"volume_id\": 1,\n        \"created_at\": \"2015-06-11 08:23:47 UTC\",\n        \"modified_at\": \"2015-06-11 08:25:05 UTC\"\n      }\n    ],\n    \"count\": 4\n  }\n}"
        },
        {
          "uri": "/images/{id}",
          "method": "GET",
          "description": "Show one image details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-image-response>\n    <status type=\"integer\">0</status>\n    <image>\n      <name>img-00000002</name>\n      <display-name>mysql</display-name>\n      <status>normal</status>\n      <is-layered>True</is-layered>\n      <docker-id>fa81ed084842076d1b39b56d084d99ec0011cd4a5ade1056be359486a8b213e4</docker-id>\n      <license-state type=\"integer\">0</license-state>\n      <capacity-mb type=\"integer\">179</capacity-mb>\n      <repository>ubuntu</repository>\n      <tag>latest</tag>\n      <volume-id type=\"integer\">1</volume-id>\n      <created-at type=\"datetime\">2015-06-11T11:23:47+0300</created-at>\n      <modified-at type=\"datetime\">2015-06-11T11:25:05+0300</modified-at>\n    </image>\n</show-one-image-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"image\": {\n      \"name\": \"img-00000002\",\n      \"display_name\": \"mysql\",\n      \"status\": \"normal\",\n      \"is_layered\": \"True\",\n      \"docker_id\": \"fa81ed084842076d1b39b56d084d99ec0011cd4a5ade1056be359486a8b213e4\",\n      \"license_state\": 0,\n      \"capacity_mb\": 179,\n      \"repository\": \"ubuntu\",\n      \"tag\": \"latest\",\n      \"volume_id\": 1,\n      \"created_at\": \"2015-06-11 08:23:47 UTC\",\n      \"modified_at\": \"2015-06-11 08:25:05 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/images/{id}",
          "method": "DELETE",
          "description": "Delete an Image.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-image-response>\n    <image-name>img-00000001</image-name>\n    <status type=\"integer\">0</status>\n</delete-image-response>\n",
          "response_json": "{\n  \"response\": {\n    \"image_name\": \"img-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/images/{id}/containers",
          "method": "GET",
          "description": "Show Image Containers.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-image-containers-response>\n    <status type=\"integer\">0</status>\n</show-image-containers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/images",
          "method": "POST",
          "description": "Create an Image.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "required": true,
              "description": "Image display name",
              "example": "image1"
            },
            {
              "name": "mode",
              "type": "string",
              "required": true,
              "description": "docker or volume",
              "example": "docker"
            },
            {
              "name": "volume",
              "type": "string",
              "description": "when importing from volume , provide the volume name (e.g volume-00000001)"
            },
            {
              "name": "path",
              "type": "string",
              "required": true,
              "example": "busybox",
              "description": "The image path: when importing from volume provide path to image . when pulling from repository , provide image name. examples: docker/redis.tar (from volume)  /  ubuntu (from docker)"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-image-response>\n    <image-name>img-00000001</image-name>\n    <status type=\"integer\">0</status>\n</create-image-response>\n",
          "response_json": "{\n  \"response\": {\n    \"image_name\": \"img-00000001\",\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Containers",
      "description": "Operations involving containers.",
      "methods": [
        {
          "uri": "/containers",
          "method": "GET",
          "description": "Returns a list of all containers.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-containers-response>\n    <status type=\"integer\">0</status>\n    <containers-count type=\"integer\">2</containers-count>\n    <containers type=\"array\">\n        <container>\n          <name>container-00000001</name>\n          <display-name>n1</display-name>\n          <image-name>img-00000001</image-name>\n          <image-display-name>nginx</image-display-name>\n          <image-id type=\"integer\">1</image-id>\n          <memory-pool-name>dgroup-00000001</memory-pool-name>\n          <memory-pool-display-name>default_dgroup</memory-pool-display-name>\n          <status>normal</status>\n          <entrypoint/>\n          <ip>...</ip>\n          <udp>True</udp>\n          <use-public-ip type=\"integer\">False</use-public-ip>\n          <docker-id>b6466ad59d55e66b9313af29e7a62bd823ad7c283420b39e77a44e600d322d1c</docker-id>\n          <play-mode type=\"integer\">2</play-mode>\n          <server-id type=\"integer\">2</server-id>\n          <exit-code type=\"integer\">0</exit-code>\n          <created-at type=\"datetime\">2015-06-11T08:49:31+0300</created-at>\n          <modified-at type=\"datetime\">2015-06-11T08:49:31+0300</modified-at>\n          <started-at type=\"datetime\"></started-at>\n          <exit-at type=\"datetime\"></exit-at>\n          <ports type=\"array\"/>\n          <volumes type=\"array\">\n            <volume>\n              <id type=\"integer\">2</id>\n              <path>...</path>\n              <access>rw</access>\n              <display-name>aaa</display-name>\n              <data-type>File-System</data-type>\n              <name>volume-00000002</name>\n              <is-block type=\"integer\">False</is-block>\n            </volume>\n          </volumes>\n          <envvars type=\"array\"/>\n          <args type=\"array\"/>\n        </container>\n    </containers>\n</show-containers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"containers\": [\n      {\n        \"name\": \"container-00000001\",\n        \"display_name\": \"n1\",\n        \"image_name\": \"img-00000001\",\n        \"image_display_name\": \"nginx\",\n        \"image_id\": 1,\n        \"memory_pool_name\": \"dgroup-00000001\",\n        \"memory_pool_display_name\": \"default_dgroup\",\n        \"status\": \"normal\",\n        \"entrypoint\": null,\n        \"ip\": \"...\",\n        \"udp\": \"True\",\n        \"use_public_ip\": 0,\n        \"docker_id\": \"b6466ad59d55e66b9313af29e7a62bd823ad7c283420b39e77a44e600d322d1c\",\n        \"play_mode\": 2,\n        \"server_id\": 2,\n        \"exit_code\": 0,\n        \"created_at\": \"2015-06-11 05:49:31 UTC\",\n        \"modified_at\": \"2015-06-11 05:49:31 UTC\",\n        \"started_at\": null,\n        \"exit_at\": null,\n        \"ports\": [\n\n        ],\n        \"volumes\": [\n          {\n            \"id\": 2,\n            \"path\": \"...\",\n            \"access\": \"rw\",\n            \"display_name\": \"aaa\",\n            \"data_type\": \"File-System\",\n            \"name\": \"volume-00000002\",\n            \"is_block\": 0\n          }\n        ],\n        \"envvars\": [\n\n        ],\n        \"args\": [\n\n        ]\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/containers/{id}",
          "method": "GET",
          "description": "Show one container details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-container-response>\n  <status type=\"integer\">0</status>\n  <container>\n    <name>container-00000001</name>\n    <display-name>n1</display-name>\n    <image-name>img-00000001</image-name>\n    <image-display-name>nginx</image-display-name>\n    <image-id type=\"integer\">1</image-id>\n    <memory-pool-name>dgroup-00000001</memory-pool-name>\n    <memory-pool-display-name>default_dgroup</memory-pool-display-name>\n    <status>normal</status>\n    <entrypoint/>\n    <ip>...</ip>\n    <udp>True</udp>\n    <use-public-ip type=\"integer\">False</use-public-ip>\n    <docker-id>b6466ad59d55e66b9313af29e7a62bd823ad7c283420b39e77a44e600d322d1c</docker-id>\n    <play-mode type=\"integer\">2</play-mode>\n    <server-id type=\"integer\">2</server-id>\n    <exit-code type=\"integer\">0</exit-code>\n    <created-at type=\"datetime\">2015-06-11T08:49:31+0300</created-at>\n    <modified-at type=\"datetime\">2015-06-11T08:49:31+0300</modified-at>\n    <started-at type=\"datetime\"></started-at>\n    <exit-at type=\"datetime\"></exit-at>\n    <ports type=\"array\"/>\n    <volumes type=\"array\">\n      <volume>\n        <id type=\"integer\">2</id>\n        <path>...</path>\n        <access>rw</access>\n        <display-name>aaa</display-name>\n        <data-type>File-System</data-type>\n        <name>volume-00000002</name>\n        <is-block type=\"integer\">False</is-block>\n      </volume>\n    </volumes>\n    <envvars type=\"array\"/>\n    <args type=\"array\"/>\n    <links type=\"array\"/>\n  </container>\n</show-one-container-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"container\": {\n      \"name\": \"container-00000001\",\n      \"display_name\": \"n1\",\n      \"image_name\": \"img-00000001\",\n      \"image_display_name\": \"nginx\",\n      \"image_id\": 1,\n      \"memory_pool_name\": \"dgroup-00000001\",\n      \"memory_pool_display_name\": \"default_dgroup\",\n      \"status\": \"normal\",\n      \"entrypoint\": null,\n      \"ip\": \"...\",\n      \"udp\": \"True\",\n      \"use_public_ip\": 0,\n      \"docker_id\": \"b6466ad59d55e66b9313af29e7a62bd823ad7c283420b39e77a44e600d322d1c\",\n      \"play_mode\": 2,\n      \"server_id\": 2,\n      \"exit_code\": 0,\n      \"created_at\": \"2015-06-11 05:49:31 UTC\",\n      \"modified_at\": \"2015-06-11 05:49:31 UTC\",\n      \"started_at\": null,\n      \"exit_at\": null,\n      \"ports\": [\n\n      ],\n      \"volumes\": [\n        {\n          \"id\": 2,\n          \"path\": \"...\",\n          \"access\": \"rw\",\n          \"display_name\": \"aaa\",\n          \"data_type\": \"File-System\",\n          \"name\": \"volume-00000002\",\n          \"is_block\": 0\n        }\n      ],\n      \"envvars\": [\n\n      ],\n      \"args\": [\n\n      ],\n      \"links\": [\n\n      ]\n    }\n  }\n}"
        },
        {
          "uri": "/containers/{id}",
          "method": "DELETE",
          "description": "Delete a container.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-container-response>\n    <container-name>container-00000001</container-name>\n    <status type=\"integer\">0</status>\n</delete-container-response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_name\": \"container-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/containers/{id}/start",
          "method": "POST",
          "description": "Start a container.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<start-container-response>\n    <container-name>container-00000001</container-name>\n    <status type=\"integer\">0</status>\n</start-container-response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_name\": \"container-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/containers/{id}/stop",
          "method": "POST",
          "description": "Stop a container.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<stop-container-response>\n    <container-name>container-00000001</container-name>\n    <status type=\"integer\">0</status>\n</stop-container-response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_name\": \"container-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/containers",
          "method": "POST",
          "description": "Create a container.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "required": true,
              "description": "Display name",
              "example": "container1"
            },
            {
              "name": "imagename",
              "type": "string",
              "required": true,
              "description": "Image name",
              "example": "image-00000001"
            },
            {
              "name": "use_public_ip",
              "type": "string",
              "required": true,
              "description": "Use public ip (or frontend ip)",
              "example": "YES"
            },
            {
              "name": "start",
              "type": "string",
              "description": "Start the container after creation",
              "example": "YES"
            },
            {
              "name": "volumes",
              "type": "Array",
              "description": "Volumes to attach to container (access_type:vol-name:path)",
              "example": "[{\"name\":\"volume-00000001\",\"path\":\"/path/to/folder\",\"access\":\"rw\"},{\"name\":\"volume-00000002\",\"path\":\"/path/to/folder2\",\"access\":\"rw\"}]",
              "example_as_json_string": true
            },
            {
              "name": "ports",
              "type": "Array",
              "description": "Exposed ports",
              "example": "[{\"protocol\":\"tcp\",\"low\":22,\"high\":null , \"internal_low\": 9999}, {\"protocol\":\"udp\",\"low\":33,\"high\":35}]",
              "example_as_json_string": true
            },
            {
              "name": "args",
              "type": "Array",
              "description": "Args list",
              "example": [
                {
                  "arg": "--compress"
                },
                {
                  "arg": "--verbose"
                }
              ]
            },
            {
              "name": "envvars",
              "type": "Array",
              "description": "Environment variables",
              "example": "[{\"variable\":\"var1\",\"value\":5},{\"variable\":\"var2\",\"value\":2}]",
              "example_as_json_string": true
            },
            {
              "name": "entrypoint",
              "type": "string",
              "description": "Entry point - the script to run when starting the container",
              "example": "/usr/sbin/sshd"
            },
            {
              "name": "link",
              "type": "Array",
              "description": "Link to other containers",
              "example": "[\"container-00000001\" , \"container-00000002\"]",
              "example_as_json_string": true
            },
            {
              "name": "memorypoolname",
              "type": "string",
              "description": "Container memory pool",
              "example": "dgroup-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-container-response>\n    <container-name>container-00000001</container-name>\n    <status type=\"integer\">0</status>\n</create-container-response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_name\": \"container-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/containers/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<get_container_perf-response>\n    <container-name>container-00000001</container-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <mem-used type=\"float\">0</mem-used>\n             <time>2014-08-27T11:50:45+0300</time>\n        </usage>\n        <usage>\n            <mem-used type=\"float\">0</mem-used>\n             <time>2014-08-27T11:50:45+0300</time>\n        </usage>\n    </usages>\n</get_container_perf-response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_name\": \"container-00000001\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"mem_used\": 0.0,\n        \"time\": \"2014-08-27T11:50:45+0300\"\n      },\n      {\n        \"mem_used\": 0.0,\n        \"time\": \"2014-08-27T11:50:45+0300\"\n      }\n    ],\n    \"count\": 20\n  }\n}"
        },
        {
          "uri": "/container_memory_pools",
          "method": "GET",
          "description": "Returns a list of all container memory pools.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n    <count type=\"integer\">2</count>\n    <container-memory-pools type=\"array\">\n        <container-memory-pool>\n          <name>dgroup-00000001</name>\n          <display-name>n1</display-name>\n          <mb>333</mb>\n          <containers type=\"array\">\n            <container>\n              <display-name>aaa</display-name>\n              <name>volume-00000002</name>\n            </container>\n          </containers>\n        </container-memory-pool>\n    </container-memory-pools>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"container_memory_pools\": [\n      {\n        \"name\": \"dgroup-00000001\",\n        \"display_name\": \"n1\",\n        \"mb\": \"333\",\n        \"containers\": [\n          {\n            \"display_name\": \"aaa\",\n            \"name\": \"volume-00000002\"\n          }\n        ]\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/container_memory_pools/{id}",
          "method": "GET",
          "description": "Show one container memory pool details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <container-memory-pool>\n    <name>dgroup-00000001</name>\n    <display-name>n1</display-name>\n    <mb>333</mb>\n    <containers type=\"array\">\n      <container>\n        <display-name>aaa</display-name>\n        <name>volume-00000002</name>\n      </container>\n    </containers>\n  </container-memory-pool>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"container_memory_pool\": {\n      \"name\": \"dgroup-00000001\",\n      \"display_name\": \"n1\",\n      \"mb\": \"333\",\n      \"containers\": [\n        {\n          \"display_name\": \"aaa\",\n          \"name\": \"volume-00000002\"\n        }\n      ]\n    }\n  }\n}"
        },
        {
          "uri": "/container_memory_pools",
          "method": "POST",
          "description": "Create a container memory pool.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "required": true,
              "description": "Display name",
              "example": "cmpool1"
            },
            {
              "name": "mb",
              "type": "integer",
              "required": true,
              "description": "memory limit (MB)",
              "example": "1500"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <container-memory-pool-name>dgroup-00000001</container-memory-pool-name>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_memory_pool_name\": \"dgroup-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/container_memory_pools/{id}",
          "method": "DELETE",
          "description": "Delete a container memory pool.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <container-memory-pool-name>dgroup-00000001</container-memory-pool-name>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_memory_pool_name\": \"dgroup-00000001\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/container_memory_pools/{id}/performance",
          "method": "GET",
          "description": "Returns the last 60 data points of performance data for the specified interval.",
          "parameters": [
            {
              "name": "interval",
              "type": "integer",
              "example": 1,
              "description": "The interval between data points, in seconds."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <container-memory-pool-name>dgroup-00000001</container-memory-pool-name>\n    <status type=\"integer\">0</status>\n    <usages-count type=\"integer\">20</usages-count>\n    <usages type=\"array\">\n        <usage>\n            <mem-used type=\"float\">0</mem-used>\n             <time>2014-08-27T11:50:45+0300</time>\n        </usage>\n        <usage>\n            <mem-used type=\"float\">0</mem-used>\n             <time>2014-08-27T11:50:45+0300</time>\n        </usage>\n    </usages>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"container_memory_pool_name\": \"dgroup-00000001\",\n    \"status\": 0,\n    \"usages\": [\n      {\n        \"mem_used\": 0.0,\n        \"time\": \"2014-08-27T11:50:45+0300\"\n      },\n      {\n        \"mem_used\": 0.0,\n        \"time\": \"2014-08-27T11:50:45+0300\"\n      }\n    ],\n    \"count\": 20\n  }\n}"
        }
      ]
    },
    {
      "name": "Snapshot Policies",
      "description": "Operations for Snapshot Policies.",
      "methods": [
        {
          "uri": "/snapshot_policies",
          "description": "Return a list of Snapshot Policies.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-snapshot-policies-response>\n    <status type=\"integer\">0</status>\n    <snapshot-policies-count type=\"integer\">3</snapshot-policies-count>\n    <snapshot-policies type=\"array\">\n        <snapshot-policy>\n            <name>policy-00000002</name>\n            <display-name>Hourly Snapshots for a Day</display-name>\n            <create-policy>0 * * * *</create-policy>\n            <delete-policy>N24</delete-policy>\n            <destination-delete-policy>N24</destination-delete-policy>\n            <paused>NO</paused>\n            <create-empty type=\"boolean\">YES</create-empty>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </snapshot-policy>\n        <snapshot-policy>\n            <name>policy-00000003</name>\n            <display-name>Daily Snapshots for a Week</display-name>\n            <create-policy>0 0 * * *</create-policy>\n            <delete-policy>N7</delete-policy>\n            <destination-delete-policy>N7</destination-delete-policy>\n            <paused>NO</paused>\n            <create-empty type=\"boolean\">NO</create-empty>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </snapshot-policy>\n        <snapshot-policy>\n            <name>policy-00000004</name>\n            <display-name>Weekly Snapshots for a Year</display-name>\n            <create-policy>0 0 * * 0</create-policy>\n            <delete-policy>N53</delete-policy>\n            <destination-delete-policy>N53</destination-delete-policy>\n            <paused>NO</paused>\n            <create-empty type=\"boolean\">NO</create-empty>\n            <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n            <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n        </snapshot-policy>\n    </snapshot-policies>\n</show-snapshot-policies-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshot_policies\": [\n      {\n        \"name\": \"policy-00000002\",\n        \"display_name\": \"Hourly Snapshots for a Day\",\n        \"create_policy\": \"0 * * * *\",\n        \"delete_policy\": \"N24\",\n        \"destination_delete_policy\": \"N24\",\n        \"paused\": \"NO\",\n        \"create_empty\": false,\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"policy-00000003\",\n        \"display_name\": \"Daily Snapshots for a Week\",\n        \"create_policy\": \"0 0 * * *\",\n        \"delete_policy\": \"N7\",\n        \"destination_delete_policy\": \"N7\",\n        \"paused\": \"NO\",\n        \"create_empty\": false,\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      },\n      {\n        \"name\": \"policy-00000004\",\n        \"display_name\": \"Weekly Snapshots for a Year\",\n        \"create_policy\": \"0 0 * * 0\",\n        \"delete_policy\": \"N53\",\n        \"destination_delete_policy\": \"N53\",\n        \"paused\": \"NO\",\n        \"create_empty\": false,\n        \"created_at\": \"2013-09-25 09:22:25 UTC\",\n        \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n      }\n    ],\n    \"count\": 3\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{id}",
          "method": "GET",
          "description": "Show a Snapshot Policy.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-snapshot-policy-response>\n    <status type=\"integer\">0</status>\n    <snapshot-policy>\n        <name>policy-00000002</name>\n        <display-name>Hourly Snapshots for a Day</display-name>\n        <create-policy>0 * * * *</create-policy>\n        <delete-policy>N24</delete-policy>\n        <destination-delete-policy>N24</destination-delete-policy>\n        <paused>NO</paused>\n        <created-at type=\"datetime\">2013-09-25 09:22:25</created-at>\n        <modified-at type=\"datetime\">2013-09-25 09:22:25</modified-at>\n    </snapshot-policy>\n</show-one-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshot_policy\": {\n      \"name\": \"policy-00000002\",\n      \"display_name\": \"Hourly Snapshots for a Day\",\n      \"create_policy\": \"0 * * * *\",\n      \"delete_policy\": \"N24\",\n      \"destination_delete_policy\": \"N24\",\n      \"paused\": \"NO\",\n      \"created_at\": \"2013-09-25 09:22:25 UTC\",\n      \"modified_at\": \"2013-09-25 09:22:25 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/snapshot_policies",
          "method": "POST",
          "description": "Create a Snapshot Policy.",
          "parameters": [
            {
              "name": "name",
              "required": true,
              "type": "string",
              "description": "Snapshot policy name",
              "example": "my-policy"
            },
            {
              "name": "create_policy",
              "required": true,
              "type": "string",
              "description": "Define the minimal interval of snapshot creation. The format is similar to a cron job - Minute, Hour, Day of Month, Month, Day Of Week (Minute supports random value - D0)",
              "example": "5 * * * *"
            },
            {
              "name": "delete_policy",
              "required": true,
              "type": "string",
              "description": "minutes hours days or N number_of_snapshots_to_keep.",
              "example": "N7"
            },
            {
              "name": "destination_policy",
              "type": "string",
              "description": "Relevant only for Remote Mirroring where the remote Volume snapshot deletion policy is different than the source Volume. Set N number_of_snapshots_to_keep.",
              "example": "N6"
            },
            {
              "name": "empty",
              "type": "string",
              "description": "Allow empty creation snapshots (snapshot even when no data has changed)",
              "options": "YES, NO",
              "example": false
            },
            {
              "name": "attach",
              "type": "string",
              "description": "Attach policy by default for new volumes",
              "options": "YES, NO",
              "example": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-snapshot-policy-response>\n    <snapshot-policy-name>policy-00000005</snapshot-policy-name>\n    <status type=\"integer\">0</status>\n</create-snapshot-policy-response>\n  \n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_policy_name\": \"policy-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{id}",
          "method": "DELETE",
          "description": "Delete a Snapshot Policy. The Policy must not be attached to any Volume",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-snapshot-policy-response>\n    <snapshot-policy-name>policy-00000005</snapshot-policy-name>\n    <status type=\"integer\">0</status>\n</delete-snapshot-policy-response>\n  \n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_policy_name\": \"policy-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{id}",
          "method": "PUT",
          "description": "Update a Snapshot Policy creation and deletion rules. The update will apply to all Volumes to which this policy is applied",
          "parameters": [
            {
              "name": "displayname",
              "required": false,
              "type": "string",
              "description": "Snapshot policy name",
              "example": "my-policy"
            },
            {
              "name": "create_policy",
              "required": true,
              "type": "string",
              "example": "5 * * * *",
              "description": "Define the minimal interval of snapshot creation. The format is similar to a cron job - Minute, Hour, Day of Month, Month, Day Of Week (Minute supports random value - D0)"
            },
            {
              "name": "delete_policy",
              "required": true,
              "description": "minutes hours days or N number_of_snapshots_to_keep.",
              "type": "string",
              "example": "N7"
            },
            {
              "name": "destination_policy",
              "type": "string",
              "example": "N6",
              "description": "Relevant only for Remote Mirroring where the remote Volume snapshot deletion policy is different than the source Volume. Set N number_of_snapshots_to_keep."
            },
            {
              "name": "empty",
              "type": "string",
              "description": "Allow empty creation snapshots (snapshot even when no data has changed)",
              "options": "YES, NO",
              "example": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-snapshot-policy-response>\n    <snapshot-policy-name>policy-00000003</snapshot-policy-name>\n    <status type=\"integer\">0</status>\n</update-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_policy_name\": \"policy-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{id}/rename",
          "method": "POST",
          "description": "Rename a Snapshot Policy.",
          "parameters": [
            {
              "name": "new_name",
              "type": "string",
              "required": true,
              "description": "Snapshot policy new name",
              "example": "my-policy"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rename-snapshot-policy-response>\n    <snapshot-policy-name>policy-00000003</snapshot-policy-name>\n    <status type=\"integer\">0</status>\n</rename-snapshot-policy-response>\n",
          "response_json": "{\n  \"response\": {\n    \"snapshot_policy_name\": \"policy-00000003\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/snapshot_policies/{id}/volumes",
          "method": "GET",
          "description": "Show Volumes using a Snapshot Policy.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <volumes-count type=\"integer\">1</volumes-count>\n  <volumes type=\"array\">\n    <volume>\n      <name>volume-00000001</name>\n      <display-name>test</display-name>\n      <cg-display-name>test</cg-display-name>\n      <cg-name>cg-00000001</cg-name>\n      <cg-user-created>NO</cg-user-created>\n      <pool-display-name>p1</pool-display-name>\n      <pool-name>pool-00000001</pool-name>\n      <status>Available</status>\n      <virtual-capacity type=\"integer\">55</virtual-capacity>\n      <server-name nil=\"true\"/>\n      <data-type>File-System</data-type>\n      <thin>NO</thin>\n      <encryption>NO</encryption>\n      <encryption-key-size>0</encryption-key-size>\n      <allocated-capacity type=\"float\">-1.0</allocated-capacity>\n      <data-copies-capacity type=\"float\">-1.0</data-copies-capacity>\n      <access-type nil=\"true\"/>\n      <read-only nil=\"true\"/>\n      <nfs-export-path>150.50.2.133:/export/test</nfs-export-path>\n      <smb-export-path>\\\\150.50.2.133\\test</smb-export-path>\n      <mount-sync>YES</mount-sync>\n      <atime-update>NO</atime-update>\n      <ext-metering>NO</ext-metering>\n      <images-repo>NO</images-repo>\n      <nfs-root-squash>NO</nfs-root-squash>\n      <smb-only>NO</smb-only>\n      <smb-guest>NO</smb-guest>\n      <smb-windows-acl>NO</smb-windows-acl>\n      <smb-map-archive>YES</smb-map-archive>\n      <smb-file-create-mask>0744</smb-file-create-mask>\n      <smb-dir-create-mask>0755</smb-dir-create-mask>\n      <smb-aio-size type=\"integer\">1</smb-aio-size>\n      <smb-browseable>YES</smb-browseable>\n      <smb-hidden-files nil=\"true\"/>\n      <smb-encryption-mode>desired</smb-encryption-mode>\n      <smb-hide-unreadable>NO</smb-hide-unreadable>\n      <smb-hide-unwriteable>NO</smb-hide-unwriteable>\n      <smb-hide-dot-files>NO</smb-hide-dot-files>\n      <smb-store-dos-attributes>NO</smb-store-dos-attributes>\n      <capacity-history type=\"integer\">60</capacity-history>\n      <alert-mode type=\"integer\">360</alert-mode>\n      <uquota-state>off</uquota-state>\n      <gquota-state>off</gquota-state>\n      <pquota-state>off</pquota-state>\n      <target nil=\"true\"/>\n      <lun nil=\"true\"/>\n      <cache nil=\"true\"/>\n      <tenant-id type=\"integer\">10</tenant-id>\n      <has-mirror>NO</has-mirror>\n      <has-backup>NO</has-backup>\n      <has-snapshots>YES</has-snapshots>\n      <shadow-copy-enabled>NO</shadow-copy-enabled>\n      <is-shadow-copy-clone>NO</is-shadow-copy-clone>\n      <read-iops-limit>0</read-iops-limit>\n      <read-mbps-limit>0</read-mbps-limit>\n      <write-iops-limit>0</write-iops-limit>\n      <write-mbps-limit>0</write-mbps-limit>\n      <thresholds nil=\"true\"/>\n      <comment nil=\"true\"/>\n      <created-at type=\"dateTime\">2017-08-30T07:34:32+00:00</created-at>\n      <modified-at type=\"dateTime\">2017-08-30T07:34:33+00:00</modified-at>\n    </volume>\n  </volumes>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"volumes\": [\n      {\n        \"name\": \"volume-00000001\",\n        \"display_name\": \"test\",\n        \"cg_display_name\": \"test\",\n        \"cg_name\": \"cg-00000001\",\n        \"cg_user_created\": \"NO\",\n        \"pool_display_name\": \"p1\",\n        \"pool_name\": \"pool-00000001\",\n        \"status\": \"Available\",\n        \"virtual_capacity\": 55,\n        \"server_name\": null,\n        \"data_type\": \"File-System\",\n        \"thin\": \"NO\",\n        \"encryption\": \"NO\",\n        \"encryption_key_size\": \"0\",\n        \"allocated_capacity\": -1.0,\n        \"data_copies_capacity\": -1.0,\n        \"access_type\": null,\n        \"read_only\": null,\n        \"nfs_export_path\": \"150.50.2.133:/export/test\",\n        \"smb_export_path\": \"\\\\\\\\150.50.2.133\\\\test\",\n        \"mount_sync\": \"YES\",\n        \"atime_update\": \"NO\",\n        \"ext_metering\": \"NO\",\n        \"images_repo\": \"NO\",\n        \"nfs_root_squash\": \"NO\",\n        \"smb_only\": \"NO\",\n        \"smb_guest\": \"NO\",\n        \"smb_windows_acl\": \"NO\",\n        \"smb_map_archive\": \"YES\",\n        \"smb_file_create_mask\": \"0744\",\n        \"smb_dir_create_mask\": \"0755\",\n        \"smb_aio_size\": 1,\n        \"smb_browseable\": \"YES\",\n        \"smb_hidden_files\": null,\n        \"smb_encryption_mode\": \"desired\",\n        \"smb_hide_unreadable\": \"NO\",\n        \"smb_hide_unwriteable\": \"NO\",\n        \"smb_hide_dot_files\": \"NO\",\n        \"smb_store_dos_attributes\": \"NO\",\n        \"capacity_history\": 60,\n        \"alert_mode\": 360,\n        \"uquota_state\": \"off\",\n        \"gquota_state\": \"off\",\n        \"pquota_state\": \"off\",\n        \"target\": null,\n        \"lun\": null,\n        \"cache\": null,\n        \"tenant_id\": 10,\n        \"has_mirror\": \"NO\",\n        \"has_backup\": \"NO\",\n        \"has_snapshots\": \"YES\",\n        \"shadow_copy_enabled\": \"NO\",\n        \"is_shadow_copy_clone\": \"NO\",\n        \"read_iops_limit\": \"0\",\n        \"read_mbps_limit\": \"0\",\n        \"write_iops_limit\": \"0\",\n        \"write_mbps_limit\": \"0\",\n        \"thresholds\": null,\n        \"comment\": null,\n        \"created_at\": \"2017-08-30 07:34:32 UTC\",\n        \"modified_at\": \"2017-08-30 07:34:33 UTC\"\n      }\n    ],\n    \"count\": 1\n  }\n}"
        }
      ]
    },
    {
      "name": "Snapshots",
      "description": "Operations for Snapshots.",
      "methods": [
        {
          "uri": "/snapshots",
          "method": "GET",
          "description": "Get snapshots.",
          "response": "<show-snapshots-response>\n  <status type=\"integer\">0</status>\n  <snapshots-count type=\"integer\">85</snapshots-count>\n  <snapshots type=\"array\">\n    <snapshot>\n      <name>snap-00000212</name>\n      <display-name>aa</display-name>\n      <status>normal</status>\n      <cg-display-name>smb_metadata</cg-display-name>\n      <cg-name>cg-0000000a</cg-name>\n      <pool-name>pool-00010001</pool-name>\n      <application>Snapshot Manager</application>\n      <volume-ext-name>volume-00000001</volume-ext-name>\n      <volume-display-name>v1</volume-display-name>\n      <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n      <created-at type=\"datetime\">2020-03-08T12:21:33+0000</created-at>\n      <modified-at type=\"datetime\">2020-03-08T12:21:33+0000</modified-at>\n    </snapshot>\n    <snapshot>\n      <name>snap-0000021d</name>\n      <display-name>s-r28-r29-r2a-1601772602420</display-name>\n      <status>normal</status>\n      <cg-display-name>share-26acf7eb-9943-434a-931f-2b80e490a0ba</cg-display-name>\n      <cg-name>cg-0000017e</cg-name>\n      <pool-name>pool-00010002</pool-name>\n      <application>Snapshot Manager</application>\n      <volume-ext-name>volume-00000002</volume-ext-name>\n      <volume-display-name>v2</volume-display-name>\n      <volume-capacity-mb type=\"integer\">102400</volume-capacity-mb>\n      <created-at type=\"datetime\">2020-10-04T00:50:02+0000</created-at>\n      <modified-at type=\"datetime\">2020-10-04T00:50:02+0000</modified-at>\n    </snapshot>\n  </snapshots>\n</show-snapshots-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshots\": [\n      {\n        \"name\": \"snap-00000212\",\n        \"display_name\": \"aa\",\n        \"status\": \"normal\",\n        \"cg_display_name\": \"smb_metadata\",\n        \"cg_name\": \"cg-0000000a\",\n        \"pool_name\": \"pool-00010001\",\n        \"application\": \"Snapshot Manager\",\n        \"volume_ext_name\": \"volume-00000001\",\n        \"volume_display_name\": \"v1\",\n        \"volume_capacity_mb\": 102400,\n        \"created_at\": \"2020-03-08 12:21:33 UTC\",\n        \"modified_at\": \"2020-03-08 12:21:33 UTC\"\n      },\n      {\n        \"name\": \"snap-0000021d\",\n        \"display_name\": \"s-r28-r29-r2a-1601772602420\",\n        \"status\": \"normal\",\n        \"cg_display_name\": \"share-26acf7eb-9943-434a-931f-2b80e490a0ba\",\n        \"cg_name\": \"cg-0000017e\",\n        \"pool_name\": \"pool-00010002\",\n        \"application\": \"Snapshot Manager\",\n        \"volume_ext_name\": \"volume-00000002\",\n        \"volume_display_name\": \"v2\",\n        \"volume_capacity_mb\": 102400,\n        \"created_at\": \"2020-10-04 00:50:02 UTC\",\n        \"modified_at\": \"2020-10-04 00:50:02 UTC\"\n      }\n    ],\n    \"count\": 85\n  }\n}"
        },
        {
          "uri": "/snapshots/snapshots_set",
          "method": "POST",
          "description": "Creates a snapshot set.",
          "parameters": [
            {
              "name": "snapshots_set_1_snap1",
              "type": "Object",
              "description": "First snapshot for the snapshot set.",
              "example": "{name: \"snap1\", cg: \"cg-00000001\"}",
              "example_as_json_string": true,
              "required": true
            },
            {
              "name": "snapshots_set_2_snap2",
              "type": "Object",
              "description": "Second snapshot for the snapshot set."
            },
            {
              "name": "snapshots_set_3_snap3",
              "type": "Object",
              "description": "Second snapshot for the snapshot set."
            },
            {
              "name": "...",
              "type": "Object"
            }
          ],
          "response": "<response>\n  <status type=\"integer\">0</status>\n  <snapshots-count type=\"integer\">2</snapshots-count>\n  <snapshots type=\"array\">\n    <snapshot>snap-00000005</snapshot>\n    <snapshot>snap-00000006</snapshot>\n  </snapshots>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"snapshots\": [\n      \"snap-00000005\",\n      \"snap-00000006\"\n    ],\n    \"count\": 2\n  }\n}"
        }
      ]
    },
    {
      "name": "Users",
      "description": "Operations for Users.",
      "methods": [
        {
          "uri": "/users",
          "description": "List all users.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <users-count type=\"integer\">1</users-count>\n    <users type=\"array\">\n        <user>\n            <id type=\"integer\">1</id>\n            <username>primaryuser</username>\n            <email>email@example.com</email>\n            <primary type=\"boolean\">true</primary>\n            <permissions type=\"array\">\n              <permission>drives_view</permission>\n            </permissions>\n            <roles type=\"array\">\n                <role>\n                  <id type=\"integer\">60</id>\n                  <name>Read Only</name>\n                </role>\n              </roles>\n            <display-timezone>Asia/Jerusalem</display-timezone>\n            <notify-on-events type=\"boolean\">true</notify-on-events>\n        </user>\n    </users>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"users\": [\n      {\n        \"id\": 1,\n        \"username\": \"primaryuser\",\n        \"email\": \"email@example.com\",\n        \"primary\": true,\n        \"permissions\": [\n          \"drives_view\"\n        ],\n        \"roles\": [\n          {\n            \"id\": 60,\n            \"name\": \"Read Only\"\n          }\n        ],\n        \"display_timezone\": \"Asia/Jerusalem\",\n        \"notify_on_events\": true\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/users",
          "method": "POST",
          "description": "Adds a new user.  Available to the primary user only.",
          "parameters": [
            {
              "name": "username",
              "type": "string",
              "description": "The new username",
              "example": "johndoe",
              "required": true
            },
            {
              "name": "email",
              "type": "string",
              "required": true,
              "description": "The new user email",
              "example": "johndoe@company.com"
            },
            {
              "name": "notify_on_events",
              "type": "string",
              "options": "YES,NO",
              "description": "Notify on system events",
              "example": "YES"
            },
            {
              "name": "notification_severity",
              "type": "string",
              "options": "low|normal|high|urgent",
              "description": "System events minimum severity to notify (valid only for users with notify_on_events enabled)",
              "example": "high"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <status-msg>User <b>newuser</b> created. Please provide the user with the following temporary passcode which they can use to create a password during their first login attempt:<br/><br/><b>ThDd9Mfn</b></status-msg>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"User  created. Please provide the user with the following temporary passcode which they can use to create a password during their first login attempt:\"\n  }\n}"
        },
        {
          "uri": "/users/{username}",
          "method": "DELETE",
          "description": "Delete a user.  Available to the primary user only.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-user-response>\n  <status type=\"integer\">0</status>\n  <status-msg>User deletion successful.</status-msg>\n</delete-user-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"User deletion successful.\"\n  }\n}"
        },
        {
          "uri": "/users/{username}/access_key",
          "description": "Reset a user's access key.",
          "nokey": true,
          "method": "POST",
          "parameters": [
            {
              "name": "username",
              "type": "string",
              "required": true,
              "example": "johndoe",
              "description": "Username or email address."
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "example": "mysupersecretpassword",
              "description": "The user password"
            },
            {
              "name": "otp_attempt",
              "type": "string",
              "required": false,
              "example": "103245",
              "description": "A dual factor authentication token"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reset-access-key-response>\n    <status type=\"integer\">0</status>\n    <status-msg>Access key changed.</status-msg>\n    <key>AWLBF0IV0CJE81L6L0OL-24</key>\n</reset-access-key-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"key\": \"AWLBF0IV0CJE81L6L0OL-24\",\n    \"message\": \"Access key changed.\"\n  }\n}"
        },
        {
          "uri": "/users/login",
          "description": "Returns a user's details.",
          "nokey": true,
          "method": "POST",
          "parameters": [
            {
              "name": "user",
              "type": "string",
              "required": true,
              "example": "johndoe",
              "description": "Username or email address."
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "example": "mysupersecretpassword",
              "description": "The user password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<current-user-response>\n    <status type=\"integer\">0</status>\n    <user>\n        <id type=\"integer\">1</id>\n        <username>johndoe</username>\n        <email>johndoe@company.com</email>\n        <permissions type=\"array\">\n          <permission>drives_view</permission>\n        </permissions>\n        <locked type=\"boolean\">false</locked>\n        <roles type=\"array\">\n          <role>\n            <id type=\"integer\">58</id>\n            <name>Read Only</name>\n          </role>\n        </roles>\n        <display-timezone></display-timezone>\n    </user>\n</current-user-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"user\": {\n      \"id\": 1,\n      \"username\": \"johndoe\",\n      \"email\": \"johndoe@company.com\",\n      \"permissions\": [\n        \"drives_view\"\n      ],\n      \"locked\": false,\n      \"roles\": [\n        {\n          \"id\": 58,\n          \"name\": \"Read Only\"\n        }\n      ],\n      \"display_timezone\": null\n    }\n  }\n}"
        },
        {
          "uri": "/users/password",
          "method": "POST",
          "description": "Change a user's password.",
          "parameters": [
            {
              "name": "user",
              "type": "string",
              "required": true,
              "example": "johndoe"
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "Existing password.",
              "example": "mysupersecretpassword"
            },
            {
              "name": "new_password",
              "type": "string",
              "required": true,
              "description": "New password.",
              "example": "mynewsupersecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<change-password-response>\n    <status type=\"integer\">0</status>\n    <status-msg>Password changed.</status-msg>\n</change-password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Password changed.\"\n  }\n}"
        },
        {
          "uri": "/users/{username}/password_code",
          "method": "POST",
          "nokey": true,
          "description": "Change a user's password using a temporary password code.",
          "parameters": [
            {
              "name": "user",
              "required": true,
              "type": "string",
              "example": "Y5cHbh",
              "description": "username"
            },
            {
              "name": "code",
              "required": true,
              "type": "string",
              "example": "Y5cHbh",
              "description": "temporary password code"
            },
            {
              "name": "new_password",
              "required": true,
              "type": "string",
              "example": "mynewpassword",
              "description": "New password"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<change-password-code-response>\n    <status type=\"integer\">0</status>\n    <status-msg>Password set successfully.</status-msg>\n</change-password-code-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Password set successfully.\"\n  }\n}"
        },
        {
          "uri": "/users/reset_password",
          "method": "POST",
          "description": "Issues a temporary password code to reset a user's password.",
          "parameters": [
            {
              "name": "username",
              "required": true,
              "description": "User to reset password",
              "type": "string",
              "example": "johndoe"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n    <status type=\"integer\">0</status>\n    <status-msg>Success!</status-msg>\n</hash>\n",
          "response_json": "{\n  \"status\": 0,\n  \"status_msg\": \"Success!\"\n}"
        },
        {
          "uri": "/users/admin_access/enable",
          "method": "POST",
          "description": "Enables cloud admin access.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<enable-admin-access-response>\n  <status type=\"integer\">0</status>\n  <status-msg>Admin access enabled.</status-msg>\n</enable-admin-access-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Admin access enabled.\"\n  }\n}"
        },
        {
          "uri": "/users/admin_access/disable",
          "method": "POST",
          "description": "Disables cloud admin access.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<disable-admin-access-response>\n  <status type=\"integer\">0</status>\n  <status-msg>Admin access disabled.</status-msg>\n</disable-admin-access-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Admin access disabled.\"\n  }\n}"
        },
        {
          "uri": "/users/{username}",
          "method": "PUT",
          "description": "Update a user's info.",
          "parameters": [
            {
              "name": "email",
              "type": "string",
              "example": "example@example.com",
              "description": "A new email address for the user."
            },
            {
              "name": "notify_on_events",
              "type": "boolean",
              "options": "true,false",
              "description": "Notify on system events",
              "example": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <message>user 2 updated</message>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"message\": \"user 2 updated\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/users/{username}/roles",
          "method": "POST",
          "description": "Update a user's roles.",
          "parameters": [
            {
              "name": "roles",
              "type": "Array",
              "example": [
                2,
                3
              ],
              "description": "Array of role ids.",
              "required": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <status-msg>User roles updated</status-msg>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"User roles updated\"\n  }\n}"
        },
        {
          "uri": "/users/password_requirements_settings",
          "method": "GET",
          "description": "Get the password requirements settings.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status>0</status>\n  <password_requirements_data>\n    <min_password_length>9</min_password_length>\n    <password_requirements_text>should contain numbers, letters, uppercase letters and special characters.</password_requirements_text>\n  </password_requirements_data>\n</response>",
          "response_json": "{\n  \"response\": {\n    \"status\": \"0\",\n    \"password_requirements_data\": {\n      \"min_password_length\": \"9\",\n      \"password_requirements_text\": \"should contain numbers, letters, uppercase letters and special characters.\"\n    }\n  }\n}"
        }
      ]
    },
    {
      "name": "Roles",
      "description": "Operations for Roles.",
      "methods": [
        {
          "uri": "/roles",
          "description": "List all roles.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <roles-count type=\"integer\">1</roles-count>\n  <roles type=\"array\">\n    <role>\n      <id type=\"integer\">1</id>\n      <name>Read Only</name>\n      <permissions type=\"array\">\n        <permission>\n          <key>drives_view</key>\n          <name>view</name>\n          <module>drives</module>\n        </permission>\n        <permission>\n          <key>raid_groups_view</key>\n          <name>view</name>\n          <module>raid_groups</module>\n        </permission>\n        <permission>\n          <key>pools_view</key>\n          <name>view</name>\n          <module>pools</module>\n        </permission>\n        <permission>\n          <key>volumes_view</key>\n          <name>view</name>\n          <module>volumes</module>\n        </permission>\n        <permission>\n          <key>servers_view</key>\n          <name>view</name>\n          <module>servers</module>\n        </permission>\n        <permission>\n          <key>vcontrollers_view</key>\n          <name>view</name>\n          <module>vcontrollers</module>\n        </permission>\n        <permission>\n          <key>remote_vpsas_view</key>\n          <name>view</name>\n          <module>remote_vpsas</module>\n        </permission>\n        <permission>\n          <key>mirror_jobs_view</key>\n          <name>view</name>\n          <module>mirror_jobs</module>\n        </permission>\n        <permission>\n          <key>images_view</key>\n          <name>view</name>\n          <module>images</module>\n        </permission>\n        <permission>\n          <key>containers_view</key>\n          <name>view</name>\n          <module>containers</module>\n        </permission>\n        <permission>\n          <key>object_storage_destinations_view</key>\n          <name>view</name>\n          <module>object_storage_destinations</module>\n        </permission>\n        <permission>\n          <key>object_storage_backup_jobs_view</key>\n          <name>view</name>\n          <module>object_storage_backup_jobs</module>\n        </permission>\n        <permission>\n          <key>object_storage_restore_jobs_view</key>\n          <name>view</name>\n          <module>object_storage_restore_jobs</module>\n        </permission>\n        <permission>\n          <key>snapshot_policies_view</key>\n          <name>view</name>\n          <module>snapshot_policies</module>\n        </permission>\n        <permission>\n          <key>snapshots_view</key>\n          <name>view</name>\n          <module>snapshots</module>\n        </permission>\n        <permission>\n          <key>nas_users_view</key>\n          <name>view</name>\n          <module>nas_users</module>\n        </permission>\n        <permission>\n          <key>nas_groups_view</key>\n          <name>view</name>\n          <module>nas_groups</module>\n        </permission>\n        <permission>\n          <key>active_directory_view</key>\n          <name>view</name>\n          <module>active_directory</module>\n        </permission>\n        <permission>\n          <key>forums_view</key>\n          <name>view</name>\n          <module>forums</module>\n        </permission>\n        <permission>\n          <key>tickets_view</key>\n          <name>view</name>\n          <module>tickets</module>\n        </permission>\n        <permission>\n          <key>settings_view</key>\n          <name>view</name>\n          <module>settings</module>\n        </permission>\n        <permission>\n          <key>users_view</key>\n          <name>view</name>\n          <module>users</module>\n        </permission>\n        <permission>\n          <key>dashboard_view</key>\n          <name>view</name>\n          <module>dashboard</module>\n        </permission>\n        <permission>\n          <key>performance_monitor_view</key>\n          <name>view</name>\n          <module>performance_monitor</module>\n        </permission>\n        <permission>\n          <key>zios_policies_name_view</key>\n          <name>name_view</name>\n          <module>zios_policies</module>\n        </permission>\n        <permission>\n          <key>users_view</key>\n          <name>users_view</name>\n          <module>zios_roles</module>\n        </permission>\n      </permissions>\n      <new-user-default type=\"boolean\">true</new-user-default>\n      <locked type=\"boolean\">true</locked>\n    </role>\n  </roles>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"roles\": [\n      {\n        \"id\": 1,\n        \"name\": \"Read Only\",\n        \"permissions\": [\n          {\n            \"key\": \"drives_view\",\n            \"name\": \"view\",\n            \"module\": \"drives\"\n          },\n          {\n            \"key\": \"raid_groups_view\",\n            \"name\": \"view\",\n            \"module\": \"raid_groups\"\n          },\n          {\n            \"key\": \"pools_view\",\n            \"name\": \"view\",\n            \"module\": \"pools\"\n          },\n          {\n            \"key\": \"volumes_view\",\n            \"name\": \"view\",\n            \"module\": \"volumes\"\n          },\n          {\n            \"key\": \"servers_view\",\n            \"name\": \"view\",\n            \"module\": \"servers\"\n          },\n          {\n            \"key\": \"vcontrollers_view\",\n            \"name\": \"view\",\n            \"module\": \"vcontrollers\"\n          },\n          {\n            \"key\": \"remote_vpsas_view\",\n            \"name\": \"view\",\n            \"module\": \"remote_vpsas\"\n          },\n          {\n            \"key\": \"mirror_jobs_view\",\n            \"name\": \"view\",\n            \"module\": \"mirror_jobs\"\n          },\n          {\n            \"key\": \"images_view\",\n            \"name\": \"view\",\n            \"module\": \"images\"\n          },\n          {\n            \"key\": \"containers_view\",\n            \"name\": \"view\",\n            \"module\": \"containers\"\n          },\n          {\n            \"key\": \"object_storage_destinations_view\",\n            \"name\": \"view\",\n            \"module\": \"object_storage_destinations\"\n          },\n          {\n            \"key\": \"object_storage_backup_jobs_view\",\n            \"name\": \"view\",\n            \"module\": \"object_storage_backup_jobs\"\n          },\n          {\n            \"key\": \"object_storage_restore_jobs_view\",\n            \"name\": \"view\",\n            \"module\": \"object_storage_restore_jobs\"\n          },\n          {\n            \"key\": \"snapshot_policies_view\",\n            \"name\": \"view\",\n            \"module\": \"snapshot_policies\"\n          },\n          {\n            \"key\": \"snapshots_view\",\n            \"name\": \"view\",\n            \"module\": \"snapshots\"\n          },\n          {\n            \"key\": \"nas_users_view\",\n            \"name\": \"view\",\n            \"module\": \"nas_users\"\n          },\n          {\n            \"key\": \"nas_groups_view\",\n            \"name\": \"view\",\n            \"module\": \"nas_groups\"\n          },\n          {\n            \"key\": \"active_directory_view\",\n            \"name\": \"view\",\n            \"module\": \"active_directory\"\n          },\n          {\n            \"key\": \"forums_view\",\n            \"name\": \"view\",\n            \"module\": \"forums\"\n          },\n          {\n            \"key\": \"tickets_view\",\n            \"name\": \"view\",\n            \"module\": \"tickets\"\n          },\n          {\n            \"key\": \"settings_view\",\n            \"name\": \"view\",\n            \"module\": \"settings\"\n          },\n          {\n            \"key\": \"users_view\",\n            \"name\": \"view\",\n            \"module\": \"users\"\n          },\n          {\n            \"key\": \"dashboard_view\",\n            \"name\": \"view\",\n            \"module\": \"dashboard\"\n          },\n          {\n            \"key\": \"performance_monitor_view\",\n            \"name\": \"view\",\n            \"module\": \"performance_monitor\"\n          },\n          {\n            \"key\": \"zios_policies_name_view\",\n            \"name\": \"name_view\",\n            \"module\": \"zios_policies\"\n          },\n          {\n            \"key\": \"users_view\",\n            \"name\": \"users_view\",\n            \"module\": \"zios_roles\"\n          }\n        ],\n        \"new_user_default\": true,\n        \"locked\": true\n      }\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/roles/all_permissions",
          "description": "List all available permissions.",
          "method": "GET",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <permissions-count type=\"integer\">4</permissions-count>\n  <permissions type=\"array\">\n    <permission>\n      <key>drives_view</key>\n      <type>view</type>\n      <name>view</name>\n      <read>1</read>\n      <module>Drives</module>\n    </permission>\n    <permission>\n      <key>drives_create</key>\n      <type>create</type>\n      <name>create</name>\n      <read>0</read>\n      <module>Drives</module>\n    </permission>\n    <permission>\n      <key>drives_update</key>\n      <type>update</type>\n      <name>update</name>\n      <read>0</read>\n      <module>Drives</module>\n    </permission>\n    <permission>\n      <key>drives_delete</key>\n      <type>delete</type>\n      <name>delete</name>\n      <read>0</read>\n      <module>Drives</module>\n    </permission>\n  </permissions>\n</hash>\n",
          "response_json": "{\n  \"permissions_count\": 4,\n  \"permissions\": [\n    {\n      \"key\": \"drives_view\",\n      \"type\": \"view\",\n      \"name\": \"view\",\n      \"read\": \"1\",\n      \"module\": \"Drives\"\n    },\n    {\n      \"key\": \"drives_create\",\n      \"type\": \"create\",\n      \"name\": \"create\",\n      \"read\": \"0\",\n      \"module\": \"Drives\"\n    },\n    {\n      \"key\": \"drives_update\",\n      \"type\": \"update\",\n      \"name\": \"update\",\n      \"read\": \"0\",\n      \"module\": \"Drives\"\n    },\n    {\n      \"key\": \"drives_delete\",\n      \"type\": \"delete\",\n      \"name\": \"delete\",\n      \"read\": \"0\",\n      \"module\": \"Drives\"\n    }\n  ]\n}"
        },
        {
          "uri": "/roles",
          "method": "POST",
          "description": "Add a new role.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "description": "The new role name",
              "example": "role1",
              "required": true
            },
            {
              "name": "permissions",
              "type": "Array",
              "example": [
                "drives_create",
                "drives_update",
                "drives_delete"
              ],
              "description": "Array of permissions names.",
              "required": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <status-msg>Operation successful</status-msg>\n  <role-id type=\"integer\">1</role-id>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"role_id\": 1,\n    \"message\": \"Operation successful\"\n  }\n}"
        },
        {
          "uri": "/roles/{role-id}",
          "method": "PUT",
          "description": "Update a role.",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "description": "Name of the role",
              "example": "role2",
              "required": true
            },
            {
              "name": "permissions",
              "type": "Array",
              "example": [
                "drives_create",
                "drives_update",
                "drives_delete"
              ],
              "description": "Array of permissions names.",
              "required": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <status-msg>Operation successful</status-msg>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Operation successful\"\n  }\n}"
        },
        {
          "uri": "/roles/{role-id}",
          "method": "DELETE",
          "description": "Delete a role.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n  <status-msg>Operation successful</status-msg>\n</response>",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"message\": \"Operation successful\"\n  }\n}"
        }
      ]
    },
    {
      "name": "NAS",
      "description": "Operations for NAS (Network Attached Storage) Users and Groups.",
      "methods": [
        {
          "uri": "/nas/users",
          "description": "Get all NAS Users.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-nas-users-response>\n    <status type=\"integer\">0</status>\n    <users-count type=\"integer\">2</users-count>\n    <users type=\"array\">\n        <user>\n            <name>root</name>\n            <nfs-uid>0</nfs-uid>\n            <password>No</password>\n        </user>\n        <user>\n            <name>nobody</name>\n            <nfs-uid>1000000</nfs-uid>\n            <password>No</password>\n        </user>\n    </users>\n</show-nas-users-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"users\": [\n      {\n        \"name\": \"root\",\n        \"nfs_uid\": \"0\",\n        \"password\": \"No\"\n      },\n      {\n        \"name\": \"nobody\",\n        \"nfs_uid\": \"1000000\",\n        \"password\": \"No\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/nas/users",
          "method": "POST",
          "description": "Create a NAS User.",
          "parameters": [
            {
              "name": "username",
              "required": true,
              "type": "string",
              "example": "johndoe"
            },
            {
              "name": "nfs_uid",
              "required": false,
              "type": "integer",
              "description": "NFS user id"
            },
            {
              "name": "password",
              "description": "SMB password.",
              "type": "string",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-nas-user-response>\n    <nas-user-name>user</nas-user-name>\n    <status type=\"integer\">0</status>\n    <nfs-uid />\n</create-nas-user-response>\n",
          "response_json": "{\n  \"response\": {\n    \"nas_user_name\": \"user\",\n    \"status\": 0,\n    \"nfs_uid\": null\n  }\n}"
        },
        {
          "uri": "/nas/users/{name}",
          "method": "GET",
          "description": "Get the details for a single NAS User.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-nas-user-response>\n    <status type=\"integer\">0</status>\n    <user>\n        <name>root</name>\n        <nfs-uid>0</nfs-uid>\n        <password>No</password>\n    </user>\n</show-one-nas-user-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"user\": {\n      \"name\": \"root\",\n      \"nfs_uid\": \"0\",\n      \"password\": \"No\"\n    }\n  }\n}"
        },
        {
          "uri": "/nas/users/{name}/password",
          "method": "POST",
          "description": "Add/change/remove SMB password for NAS users.",
          "parameters": [
            {
              "name": "password",
              "type": "string",
              "required": false,
              "description": "Leave blank to remove the SMB password."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-nas-user-password-response>\n    <nas-user-name>nasuser</nas-user-name>\n    <status type=\"integer\">0</status>\n</set-nas-user-password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"nas_user_name\": \"nasuser\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/nas/users/{name}",
          "method": "DELETE",
          "description": "Delete a NAS User.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-nas-user-response>\n    <nas-user-name>nasuser</nas-user-name>\n    <status type=\"integer\">0</status>\n</delete-nas-user-response>\n",
          "response_json": "{\n  \"response\": {\n    \"nas_user_name\": \"nasuser\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/nas/groups",
          "description": "Show NAS Groups.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-nas-groups-response>\n    <status type=\"integer\">0</status>\n    <groups-count type=\"integer\">2</groups-count>\n    <groups type=\"array\">\n        <group>\n            <name>root</name>\n            <nfs-gid>0</nfs-gid>\n        </group>\n        <group>\n            <name>nogroup</name>\n            <nfs-gid>1000000</nfs-gid>\n        </group>\n    </groups>\n</show-nas-groups-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"groups\": [\n      {\n        \"name\": \"root\",\n        \"nfs_gid\": \"0\"\n      },\n      {\n        \"name\": \"nogroup\",\n        \"nfs_gid\": \"1000000\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/nas/groups",
          "description": "Create a NAS group.",
          "method": "POST",
          "parameters": [
            {
              "name": "group_name",
              "type": "string",
              "required": true,
              "description": "New group name",
              "example": "admins"
            },
            {
              "name": "nfs_gid",
              "type": "integer",
              "required": true,
              "description": "NFS new group id",
              "example": 15000
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-nas-group-response>\n    <nas-group-name>group</nas-group-name>\n    <status type=\"integer\">0</status>\n    <nfs-gid>12345</nfs-gid>\n</create-nas-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"nas_group_name\": \"group\",\n    \"status\": 0,\n    \"nfs_gid\": \"12345\"\n  }\n}"
        },
        {
          "uri": "/nas/groups/{name}",
          "method": "GET",
          "description": "Get the details for a single NAS Group.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-one-nas-group-response>\n    <status type=\"integer\">0</status>\n    <group>\n        <name>root</name>\n        <nfs-gid>0</nfs-gid>\n    </group>\n</show-one-nas-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"group\": {\n      \"name\": \"root\",\n      \"nfs_gid\": \"0\"\n    }\n  }\n}"
        },
        {
          "uri": "/nas/groups/{name}",
          "method": "DELETE",
          "description": "Delete a NAS Group.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-nas-group-response>\n    <nas-group-name>group</nas-group-name>\n    <status type=\"integer\">0</status>\n</delete-nas-group-response>\n",
          "response_json": "{\n  \"response\": {\n    \"nas_group_name\": \"group\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/active_directory",
          "method": "GET",
          "description": "List the current Active Directory configuration.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-smb-security-ads-response>\n    <status type=\"integer\">0</status>\n    <smb-ads>\n      <dns type=\"array\"> \n        <ip>10.0.2.32</ip>\n        <ip>10.0.2.33</ip>\n      </dns>\n      <dc type=\"array\">\n        <ip>10.0.0.1</ip>\n        <ip>177.0.0.2</ip>\n      </dc>\n      <ad-server>WIN-8AAAABBCCDD</ad-server>\n      <realm>zadara.net</realm>\n      <workgroup>ZADARA</workgroup>\n      <created-at type=\"datetime\">2013-12-16 22:45:58</created-at>\n      <modified-at type=\"datetime\">2013-12-16 22:45:58</modified-at>\n    </smb-ads>\n</show-smb-security-ads-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"smb_ads\": {\n      \"dns\": [\n        \"10.0.2.32\",\n        \"10.0.2.33\"\n      ],\n      \"dc\": [\n        \"10.0.0.1\",\n        \"177.0.0.2\"\n      ],\n      \"ad_server\": \"WIN-8AAAABBCCDD\",\n      \"realm\": \"zadara.net\",\n      \"workgroup\": \"ZADARA\",\n      \"created_at\": \"2013-12-16 22:45:58 UTC\",\n      \"modified_at\": \"2013-12-16 22:45:58 UTC\"\n    }\n  }\n}"
        },
        {
          "uri": "/active_directory",
          "method": "POST",
          "description": "Join an Active Directory Domain.",
          "parameters": [
            {
              "name": "username",
              "required": true,
              "description": "The domain user name",
              "example": "Administrator"
            },
            {
              "name": "password",
              "required": true,
              "description": "The domain user name",
              "example": "mysupersecretpassword"
            },
            {
              "name": "realm",
              "required": true,
              "description": "The domain name.",
              "example": "mycompany"
            },
            {
              "name": "workgroup",
              "required": true,
              "description": "The domain NetBIOS name.",
              "example": "MYCOMPANY"
            },
            {
              "name": "dns",
              "required": true,
              "description": "The DNS IP(s). (use array to pass multiple)",
              "example": "11.22.33.44"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Force Active Directory Domain join"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-smb-security-ads-response>\n    <status type=\"integer\">0</status>\n</set-smb-security-ads-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/active_directory/edit",
          "method": "POST",
          "description": "configure an Active Directory Domain. (Not available while Active Directory is disabled)",
          "parameters": [
            {
              "name": "dns",
              "required": true,
              "description": "The DNS IP(s). (use array to pass multiple)",
              "example": [
                "10.0.0.10",
                "10.0.0.11"
              ]
            },
            {
              "name": "dns_lookup_realm",
              "example": "YES",
              "description": "Set auto realm lookup"
            },
            {
              "name": "dns_lookup_kdc",
              "description": "Set auto realm kdc lookup",
              "example": "YES"
            },
            {
              "name": "realm_kdc_servers",
              "description": "Set realm kdc servers",
              "example_as_json_string": true,
              "type": "Object",
              "example": "{\"realm1\": [\"kdc1\",\"kdc2\"], \"realm1\": \"\"}"
            },
            {
              "name": "add_to_ignored_domains",
              "description": "Add domains to ignored domains. domain NetBIOS name should be used as input.",
              "example": [
                "kdc1",
                "kdc2"
              ]
            },
            {
              "name": "remove_from_ignored_domains",
              "description": "Remove domains from ignored domains. domain NetBIOS name should be used as input.",
              "example": [
                "kdc1",
                "kdc2"
              ]
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-smb-ad-servers-response>\n    <status type=\"integer\">0</status>\n</set-smb-ad-servers-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/active_directory/reset",
          "method": "POST",
          "description": "Leave/Delete the current Active Directory server.",
          "parameters": [
            {
              "name": "username",
              "required": true,
              "example": "Administrator"
            },
            {
              "name": "password",
              "required": true,
              "example": "mysupersecretpassword"
            },
            {
              "name": "keep",
              "type": "boolean",
              "description": "Keep configuration as \"disabled\" for future re-connect. DEFAULT: true",
              "default": true
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Force Active Directory Domain Leave/Delete"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reset-smb-security-ads-response>\n    <status type=\"integer\">0</status>\n</reset-smb-security-ads-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/active_directory/restore",
          "method": "POST",
          "description": "Restore the current Active Directory server.",
          "parameters": [
            {
              "name": "username",
              "required": true,
              "example": "Administrator"
            },
            {
              "name": "password",
              "required": true,
              "example": "mysupersecretpassword"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES",
              "description": "Force Active Directory Domain Restore"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<restore-smb-security-ads-response>\n    <status type=\"integer\">0</status>\n</restore-smb-security-ads-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Logs",
      "description": "Retrieving logs.",
      "methods": [
        {
          "uri": "/messages",
          "method": "GET",
          "description": "Retrieve event logs.",
          "parameters": [
            {
              "name": "severity",
              "required": false,
              "type": "integer"
            },
            {
              "name": "attr_key",
              "required": false,
              "type": "string"
            },
            {
              "name": "attr_value",
              "required": false,
              "type": "string"
            },
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-messages-response>\n    <status type=\"integer\">0</status>\n    <messages-count type=\"integer\">57</messages-count>\n    <messages type=\"array\">\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-1 encryption password was changed</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 23:04:32</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-1 CHAP credentials were modified.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:59:53</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-0 has changed state to online.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:57:26</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-1 has changed state to active.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:57:17</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-1 metadata backup completed successfully.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:57:17</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-1 setting to active role was initiated.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:57:05</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-0 metadata backup completed successfully.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:56:49</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-0 is shutting down. Reason: user initiated power-off.</msg-title>\n            <msg-severity>4</msg-severity>\n            <msg-time>2013-09-26 22:56:37</msg-time>\n        </message>\n        <message>\n            <msg-title>Failover of active controller (0) started</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 22:56:36</msg-time>\n        </message>\n        <message>\n            <msg-title>Controller vsa-000007bb-vc-0 metadata backup completed successfully.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 21:22:29</msg-time>\n        </message>\n        <message>\n            <msg-title>Raid Group raid_group RAID integrity check completed successfully. 947385088 mismatched LBAs where repaired.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 17:17:32</msg-time>\n        </message>\n        <message>\n            <msg-title>Storage Pool deleteme was deleted successfully.</msg-title>\n            <msg-severity>6</msg-severity>\n            <msg-time>2013-09-26 12:16:55</msg-time>\n        </message>\n    </messages>\n</show-messages-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"messages\": [\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-1 encryption password was changed\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 23:04:32\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-1 CHAP credentials were modified.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:59:53\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-0 has changed state to online.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:57:26\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-1 has changed state to active.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:57:17\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-1 metadata backup completed successfully.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:57:17\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-1 setting to active role was initiated.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:57:05\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-0 metadata backup completed successfully.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:56:49\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-0 is shutting down. Reason: user initiated power-off.\",\n        \"msg_severity\": \"4\",\n        \"msg_time\": \"2013-09-26 22:56:37\"\n      },\n      {\n        \"msg_title\": \"Failover of active controller (0) started\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 22:56:36\"\n      },\n      {\n        \"msg_title\": \"Controller vsa-000007bb-vc-0 metadata backup completed successfully.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 21:22:29\"\n      },\n      {\n        \"msg_title\": \"Raid Group raid_group RAID integrity check completed successfully. 947385088 mismatched LBAs where repaired.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 17:17:32\"\n      },\n      {\n        \"msg_title\": \"Storage Pool deleteme was deleted successfully.\",\n        \"msg_severity\": \"6\",\n        \"msg_time\": \"2013-09-26 12:16:55\"\n      }\n    ],\n    \"count\": 57\n  }\n}"
        }
      ]
    },
    {
      "name": "Tickets",
      "description": "Operations for Tickets.",
      "methods": [
        {
          "uri": "/tickets",
          "description": "Get all user tickets.",
          "method": "GET",
          "parameters": [
            {
              "name": "start",
              "description": "The item number to start from.  0 starts from the beginning.",
              "type": "integer",
              "required": false
            },
            {
              "name": "limit",
              "description": "The total number of records to return.",
              "type": "integer",
              "required": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<show-user-tickets-response>\n  <status type=\"integer\">0</status>\n  <tickets-count type=\"integer\">91</tickets-count>\n  <tickets type=\"array\">\n    <ticket>\n      <id type=\"integer\">46742</id>\n      <created-at>2012-07-10T14:38:08Z</created-at>\n      <updated-at>2012-07-10T14:38:08Z</updated-at>\n      <subject>DEMO TICKET</subject>\n      <description>DEMO TICKET</description>\n      <priority>urgent</priority>\n      <status>new</status>\n      <requester-id type=\"integer\">...</requester-id>\n      <submitter-id type=\"integer\">...</submitter-id>\n      <assignee-id type=\"integer\">None</assignee-id>\n    </ticket>\n    <ticket>\n      <id type=\"integer\">46743</id>\n      <created-at>2013-07-10T14:38:08Z</created-at>\n      <updated-at>2013-07-10T14:38:08Z</updated-at>\n      <subject>DEMO TICKET</subject>\n      <description>DEMO TICKET</description>\n      <priority>urgent</priority>\n      <status>new</status>\n      <requester-id type=\"integer\">...</requester-id>\n      <submitter-id type=\"integer\">...</submitter-id>\n      <assignee-id type=\"integer\">None</assignee-id>\n    </ticket>\n  </tickets>\n</show-user-tickets-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"tickets\": [\n      {\n        \"id\": 46742,\n        \"created_at\": \"2012-07-10T14:38:08Z\",\n        \"updated_at\": \"2012-07-10T14:38:08Z\",\n        \"subject\": \"DEMO TICKET\",\n        \"description\": \"DEMO TICKET\",\n        \"priority\": \"urgent\",\n        \"status\": \"new\",\n        \"requester_id\": 0,\n        \"submitter_id\": 0,\n        \"assignee_id\": 0\n      },\n      {\n        \"id\": 46743,\n        \"created_at\": \"2013-07-10T14:38:08Z\",\n        \"updated_at\": \"2013-07-10T14:38:08Z\",\n        \"subject\": \"DEMO TICKET\",\n        \"description\": \"DEMO TICKET\",\n        \"priority\": \"urgent\",\n        \"status\": \"new\",\n        \"requester_id\": 0,\n        \"submitter_id\": 0,\n        \"assignee_id\": 0\n      }\n    ],\n    \"count\": 91\n  }\n}"
        },
        {
          "uri": "/tickets",
          "description": "Create ticket.",
          "method": "POST",
          "parameters": [
            {
              "name": "subject",
              "type": "string",
              "required": true,
              "example": "my-subject",
              "description": "The ticket subject"
            },
            {
              "name": "description",
              "type": "string",
              "required": true,
              "example": "my-description",
              "description": "The ticket description"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-support-ticket-response>\n  <status type=\"integer\">0</status>\n  <ticket-id type=\"integer\">...</ticket-id>\n</create-support-ticket-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"ticket_id\": 0\n  }\n}"
        },
        {
          "uri": "/tickets/{id}/close",
          "description": "Close ticket.",
          "method": "POST",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<close-support-ticket-response>\n  <status type=\"integer\">0</status>\n</close-support-ticket-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/tickets/{id}/comments",
          "description": "Get all ticket comments.",
          "method": "GET",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<show-ticket-comments-response>\n  <status type=\"integer\">0</status>\n  <comments-count type=\"integer\">2</comments-count>\n  <comments type=\"array\">\n    <comment>\n      <id type=\"integer\">18707482730</id>\n      <created-at>2014-07-13T12:39:32Z</created-at>\n      <author-id type=\"integer\">406491184</author-id>\n      <description>Test</description>\n    </comment>\n    <comment>\n      <id type=\"integer\">18707482731</id>\n      <created-at>2014-07-13T12:39:32Z</created-at>\n      <author-id type=\"integer\">406491184</author-id>\n      <description>Test</description>\n    </comment>\n  </comments>\n</show-ticket-comments-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"comments\": [\n      {\n        \"id\": 18707482730,\n        \"created_at\": \"2014-07-13T12:39:32Z\",\n        \"author_id\": 406491184,\n        \"description\": \"Test\"\n      },\n      {\n        \"id\": 18707482731,\n        \"created_at\": \"2014-07-13T12:39:32Z\",\n        \"author_id\": 406491184,\n        \"description\": \"Test\"\n      }\n    ],\n    \"count\": 2\n  }\n}"
        },
        {
          "uri": "/tickets/{id}/comments",
          "description": "Create a comment for ticket.",
          "method": "POST",
          "parameters": [
            {
              "name": "comment",
              "type": "string",
              "required": true,
              "description": "The new comment",
              "example": "my-comment"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<comment-support-ticket-response>\n  <status type=\"integer\">0</status>\n</comment-support-ticket-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/tickets/{id}/zsnap",
          "description": "Create ticket zsnap.",
          "method": "POST",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<create-zsnap-response>\n  <status type=\"integer\">0</status>\n</create-zsnap-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        }
      ]
    },
    {
      "name": "Settings",
      "description": "Get / Modify Settings.",
      "methods": [
        {
          "uri": "/settings/nfs_domain",
          "method": "GET",
          "description": "Gets the NFS Domain associated with this VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<get-nfs-domain-response>\n  <status type=\"integer\">0</status>\n  <nfs-domain>localdomain</nfs-domain>\n</get-nfs-domain-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"nfs_domain\": \"localdomain\"\n  }\n}"
        },
        {
          "uri": "/settings/nfs_domain",
          "method": "POST",
          "description": "Sets the NFS Domain associated with this VPSA.",
          "parameters": [
            {
              "name": "domain",
              "required": true,
              "description": "The NFS domain to set",
              "type": "string",
              "example": "localdomain"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<set-nfs-domain-response>\n  <status type=\"integer\">0</status>\n  <nfs-domain>localhost</nfs-domain>\n</set-nfs-domain-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"nfs_domain\": \"localhost\"\n  }\n}"
        },
        {
          "uri": "/settings/iscsi_over_public_ip",
          "method": "POST",
          "description": "Sets iSCSI over public ip",
          "parameters": [
            {
              "name": "enabled",
              "required": true,
              "type": "boolean",
              "example": true
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<iscsi-over-public-ip-response>\n  <status type=\"integer\">0</status>\n</iscsi-over-public-ip-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/raid_read_mode",
          "method": "POST",
          "description": "Sets the raid read mode associated with this VPSA.",
          "parameters": [
            {
              "name": "readmode",
              "required": true,
              "type": "string",
              "example": "roundrobin",
              "description": "The raid read mode to set"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<set-raid-read-mode-response>\n  <status type=\"integer\">0</status>\n  <raid-read-mode>roundrobin</raid-read-mode>\n</set-raid-read-mode-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"raid_read_mode\": \"roundrobin\"\n  }\n}"
        },
        {
          "uri": "/settings/smb_charset",
          "method": "POST",
          "description": "Sets the smb charset associated with this VPSA.",
          "parameters": [
            {
              "name": "unix_charset",
              "required": true,
              "type": "string",
              "example": "UTF-8",
              "description": "The unix smb charset to set"
            },
            {
              "name": "dos_charset",
              "required": true,
              "type": "string",
              "example": "CP850",
              "description": "The dos smb charset to set"
            },
            {
              "name": "force",
              "type": "string",
              "options": "YES, NO",
              "example": "YES"
            }
          ]
        },
        {
          "uri": "/settings/smb_netbios_name",
          "method": "POST",
          "description": "Sets the smb netbios name for this VPSA.",
          "parameters": [
            {
              "name": "netbios_name",
              "required": true,
              "type": "string",
              "example": "nbtest",
              "description": "The smb netbios name to set"
            },
            {
              "name": "force",
              "options": "YES | NO",
              "description": "Force smb netbios name when volumes with SMB permissions exist"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<set-smb-unix-charset-response>\n  <status type=\"integer\">0</status>\n  <smb-unix-charset>UTF-8</smb-unix-charset>\n</set-smb-unix-charset-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"smb_unix_charset\": \"UTF-8\"\n  }\n}"
        },
        {
          "uri": "/settings/set_recycle_bin",
          "method": "POST",
          "description": "Enable/Disable recycle bin for volumes.",
          "parameters": [
            {
              "name": "recyclebin",
              "required": true,
              "type": "string",
              "options": "YES, NO",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<set-recycle-bin-response>\n  <status type=\"integer\">0</status>\n</set-recycle-bin-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/smb_trusted_domains",
          "method": "POST",
          "description": "Enable/Disable SMB trusted domains.",
          "parameters": [
            {
              "name": "allow",
              "required": true,
              "type": "string",
              "options": "YES, NO",
              "example": "YES"
            },
            {
              "name": "force",
              "desciption": "Force trusted domains if SMB shares needs to be restrated",
              "type": "string",
              "options": "YES, NO",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<set-recycle-bin-response>\n  <status type=\"integer\">0</status>\n</set-recycle-bin-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/public_ips",
          "method": "GET",
          "description": "Returns the public IP(s) associated with this VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<list-public-ips-response>\n    <status type=\"integer\">0</status>\n    <public-ips-count type=\"integer\">1</public-ips-count>\n    <public-ips type=\"array\">\n        <ip>127.0.0.1</ip>\n    </public-ips>\n</list-public-ips-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"public_ips\": [\n      \"127.0.0.1\"\n    ],\n    \"count\": 1\n  }\n}"
        },
        {
          "uri": "/settings/password_encryption",
          "method": "POST",
          "description": "Set the Master Encryption Password for your VPSA.",
          "parameters": [
            {
              "name": "encryption_pwd",
              "type": "string",
              "required": true,
              "description": "The master encryption password to set.",
              "example": "mysupersecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set_encryption_password-response>\n    <status type=\"integer\">0</status>\n</set_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/aws_encryption",
          "method": "POST",
          "description": "Set AWS KMS details for your VPSA.",
          "parameters": [
            {
              "name": "region",
              "type": "string",
              "required": true,
              "description": "The AWS KMS region code to set.",
              "example": "region-code"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS key id to set.",
              "example": "abc1def2-ghi3-jkl4-mno5-pqr6stu7vwx8"
            },
            {
              "name": "access_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS access id to set.",
              "example": "AWSACCESSID"
            },
            {
              "name": "secret",
              "type": "string",
              "required": true,
              "description": "The AWS KMS secret password to set.",
              "example": "awssecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set_encryption_password-response>\n    <status type=\"integer\">0</status>\n</set_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/kmip_encryption",
          "method": "POST",
          "description": "Set or update KMIP KMS details for your VPSA. In case VPSA has no internet access, KMS encryption will not be applied.",
          "parameters": [
            {
              "name": "host",
              "type": "string",
              "required": true,
              "description": "The KMIP host to set.",
              "example": "eu.smartkey.io"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The KMIP key UUID to set.",
              "example": "a1b2c3d4-9876-zyxw-aaaa-abcdefgh1234"
            },
            {
              "name": "key_name",
              "type": "string",
              "required": true,
              "description": "The KMIP key name to set.",
              "example": "nice-name"
            },
            {
              "name": "connect_via",
              "type": "string",
              "required": true,
              "options": "public, fe",
              "description": "The KMIP connection interface."
            },
            {
              "name": "user",
              "type": "string",
              "required": true,
              "description": "The KMIP username, can be used for authentication.",
              "example": "a1b2c3d4-e5f6-g7h8-i9j0-ab12cd12ef12"
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "The KMIP password, can be used for authentication.",
              "example": "z_a1b2c3d4a1b2c3d4a1b2c3d4qqqqq-a1b2c3d4a1b2c3d4a1b2c3d4l_a1b2c3d4a1b2c3d4a1b2c3d4zzz"
            },
            {
              "name": "port",
              "type": "integer",
              "required": false,
              "description": "The KMIP host port to set.",
              "default": 5696
            },
            {
              "name": "version",
              "type": "string",
              "required": false,
              "options": "0 (for unknown), 1 (for 1.0), 2 (for 1.1), 3 (for 1.2), 4 (for 1.3), 5 (for 1.4), 6 (for 2.0)",
              "description": "The KMIP version to use.",
              "default": "3"
            },
            {
              "name": "ca_cert_file",
              "type": "string",
              "required": false,
              "description": "The location of the CA certificate file on the VPSA file system.",
              "default": "/etc/ssl/certs/DigiCert_Global_Root_CA.pem"
            },
            {
              "name": "proxy_host",
              "type": "string",
              "required": false,
              "description": "The proxy host, used if setting KMIP KMS with proxy.",
              "example": "1.2.3.4"
            },
            {
              "name": "proxyport",
              "type": "string",
              "required": false,
              "description": "The proxy port, used if setting KMIP KMS with proxy.",
              "example": "3128"
            },
            {
              "name": "proxy_username",
              "type": "string",
              "required": false,
              "description": "The proxy user name, used if setting KMIP KMS with authenticated proxy.",
              "example": "username"
            },
            {
              "name": "proxy_password",
              "type": "string",
              "required": false,
              "description": "The proxy password, used if setting KMIP KMS with authenticated proxy.",
              "example": "mypass"
            },
            {
              "name": "key_file_content",
              "type": "string",
              "required": false,
              "description": "The private key file content, can be used for authentication."
            },
            {
              "name": "cert_file_content",
              "type": "string",
              "required": false,
              "description": "The KMIP certificate file content, can be used for authentication."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set_encryption_password-response>\n    <status type=\"integer\">0</status>\n</set_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/password_encryption",
          "method": "POST",
          "description": "Change Master Encryption Password.",
          "parameters": [
            {
              "name": "current_encryption_pwd",
              "type": "string",
              "required": true,
              "description": "Current master encryption password.",
              "example": "mycurrentsecretpassword"
            },
            {
              "name": "encryption_pwd",
              "type": "string",
              "required": true,
              "description": "The master encryption password to set.",
              "example": "mysupersecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set_encryption_password-response>\n    <status type=\"integer\">0</status>\n</set_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/aws_encryption",
          "method": "POST",
          "description": "Change encryption from using Master Encryption Password to use AWS KMS.",
          "parameters": [
            {
              "name": "current_encryption_pwd",
              "type": "string",
              "required": true,
              "description": "Current master encryption password.",
              "example": "mycurrentsecretpassword"
            },
            {
              "name": "region",
              "type": "string",
              "required": true,
              "description": "The AWS KMS region code to set.",
              "example": "region-code"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS key id to set.",
              "example": "abc1def2-ghi3-jkl4-mno5-pqr6stu7vwx8"
            },
            {
              "name": "access_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS access id to set.",
              "example": "AWSACCESSID"
            },
            {
              "name": "secret",
              "type": "string",
              "required": true,
              "description": "The AWS KMS secret password to set.",
              "example": "awssecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set_encryption_password-response>\n    <status type=\"integer\">0</status>\n</set_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/kmip_encryption",
          "method": "POST",
          "description": "Change encryption from using Master Encryption Password to use KMIP KMS.",
          "parameters": [
            {
              "name": "current_encryption_pwd",
              "type": "string",
              "required": true,
              "description": "Current master encryption password.",
              "example": "mycurrentsecretpassword"
            },
            {
              "name": "host",
              "type": "string",
              "required": true,
              "description": "The KMIP host to set.",
              "example": "eu.smartkey.io"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The KMIP key UUID to set.",
              "example": "a1b2c3d4-9876-zyxw-aaaa-abcdefgh1234"
            },
            {
              "name": "key_name",
              "type": "string",
              "required": true,
              "description": "The KMIP key name to set.",
              "example": "nice-name"
            },
            {
              "name": "connect_via",
              "type": "string",
              "required": true,
              "options": "public, fe",
              "description": "The KMIP connection interface."
            },
            {
              "name": "user",
              "type": "string",
              "required": true,
              "description": "The KMIP username, can be used for authentication.",
              "example": "a1b2c3d4-e5f6-g7h8-i9j0-ab12cd12ef12"
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "The KMIP password, can be used for authentication.",
              "example": "z_a1b2c3d4a1b2c3d4a1b2c3d4qqqqq-a1b2c3d4a1b2c3d4a1b2c3d4l_a1b2c3d4a1b2c3d4a1b2c3d4zzz"
            },
            {
              "name": "port",
              "type": "integer",
              "required": false,
              "description": "The KMIP host port to set.",
              "default": 5696
            },
            {
              "name": "version",
              "type": "string",
              "required": false,
              "options": "0 (for unknown), 1 (for 1.0), 2 (for 1.1), 3 (for 1.2), 4 (for 1.3), 5 (for 1.4), 6 (for 2.0)",
              "description": "The KMIP version to use.",
              "default": "3"
            },
            {
              "name": "ca_cert_file",
              "type": "string",
              "required": false,
              "description": "The location of the CA certificate file on the VPSA file system.",
              "default": "/etc/ssl/certs/DigiCert_Global_Root_CA.pem"
            },
            {
              "name": "proxy_host",
              "type": "string",
              "required": false,
              "description": "The proxy host, used if setting KMIP KMS with proxy.",
              "example": "1.2.3.4"
            },
            {
              "name": "proxyport",
              "type": "string",
              "required": false,
              "description": "The proxy port, used if setting KMIP KMS with proxy.",
              "example": "3128"
            },
            {
              "name": "proxy_username",
              "type": "string",
              "required": false,
              "description": "The proxy user name, used if setting KMIP KMS with authenticated proxy.",
              "example": "username"
            },
            {
              "name": "proxy_password",
              "type": "string",
              "required": false,
              "description": "The proxy password, used if setting KMIP KMS with authenticated proxy.",
              "example": "mypass"
            },
            {
              "name": "key_file_content",
              "type": "string",
              "required": false,
              "description": "The private key file content, can be used for authentication."
            },
            {
              "name": "cert_file_content",
              "type": "string",
              "required": false,
              "description": "The KMIP certificate file content, can be used for authentication."
            }
          ]
        },
        {
          "uri": "/settings/restore_encryption",
          "method": "POST",
          "description": "Restore the Master Encryption Password for your VPSA, if cleared.",
          "parameters": [
            {
              "name": "encryption_pwd",
              "type": "string",
              "required": true,
              "description": "The master encryption password to restore.",
              "example": "mysupersecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<restore_encryption_password-response>\n    <status type=\"integer\">0</status>\n</restore_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/restore_encryption_aws",
          "method": "POST",
          "description": "Restore the AWS KMS details for your VPSA, if cleared.",
          "parameters": [
            {
              "name": "region",
              "type": "string",
              "required": true,
              "description": "The AWS KMS region code to set.",
              "example": "region-code"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS key id to set.",
              "example": "abc1def2-ghi3-jkl4-mno5-pqr6stu7vwx8"
            },
            {
              "name": "access_id",
              "type": "string",
              "required": true,
              "description": "The AWS KMS access id to set.",
              "example": "AWSACCESSID"
            },
            {
              "name": "secret",
              "type": "string",
              "required": true,
              "description": "The AWS KMS secret password to set.",
              "example": "awssecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<restore_encryption_password_aws-response>\n    <status type=\"integer\">0</status>\n</restore_encryption_password_aws-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/restore_encryption_kmip",
          "method": "POST",
          "description": "Restore the KMIP KMS details for your VPSA, if cleared.",
          "parameters": [
            {
              "name": "host",
              "type": "string",
              "required": true,
              "description": "The KMIP host to set.",
              "example": "eu.smartkey.io"
            },
            {
              "name": "key_id",
              "type": "string",
              "required": true,
              "description": "The KMIP key UUID to set.",
              "example": "a1b2c3d4-9876-zyxw-aaaa-abcdefgh1234"
            },
            {
              "name": "key_name",
              "type": "string",
              "required": true,
              "description": "The KMIP key name to set.",
              "example": "nice-name"
            },
            {
              "name": "connect_via",
              "type": "string",
              "required": true,
              "options": "public, fe",
              "description": "The KMIP connection interface."
            },
            {
              "name": "user",
              "type": "string",
              "required": true,
              "description": "The KMIP username, can be used for authentication.",
              "example": "a1b2c3d4-e5f6-g7h8-i9j0-ab12cd12ef12"
            },
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "The KMIP password, can be used for authentication.",
              "example": "z_a1b2c3d4a1b2c3d4a1b2c3d4qqqqq-a1b2c3d4a1b2c3d4a1b2c3d4l_a1b2c3d4a1b2c3d4a1b2c3d4zzz"
            },
            {
              "name": "port",
              "type": "integer",
              "required": false,
              "description": "The KMIP host port to set.",
              "default": 5696
            },
            {
              "name": "version",
              "type": "string",
              "required": false,
              "options": "0 (for unknown), 1 (for 1.0), 2 (for 1.1), 3 (for 1.2), 4 (for 1.3), 5 (for 1.4), 6 (for 2.0)",
              "description": "The KMIP version to use.",
              "default": "3"
            },
            {
              "name": "ca_cert_file",
              "type": "string",
              "required": false,
              "description": "The location of the CA certificate file on the VPSA file system.",
              "default": "/etc/ssl/certs/DigiCert_Global_Root_CA.pem"
            },
            {
              "name": "proxy_host",
              "type": "string",
              "required": false,
              "description": "The proxy host, used if setting KMIP KMS with proxy.",
              "example": "1.2.3.4"
            },
            {
              "name": "proxy_port",
              "type": "string",
              "required": false,
              "description": "The proxy port, used if setting KMIP KMS with proxy.",
              "example": "3128"
            },
            {
              "name": "proxy_username",
              "type": "string",
              "required": false,
              "description": "The proxy user name, used if setting KMIP KMS with authenticated proxy.",
              "example": "username"
            },
            {
              "name": "proxy_password",
              "type": "string",
              "required": false,
              "description": "The proxy password, used if setting KMIP KMS with authenticated proxy.",
              "example": "mypass"
            },
            {
              "name": "key_file_content",
              "type": "string",
              "required": false,
              "description": "The private key file content, can be used for authentication.",
              "example": "-----BEGIN PRIVATE KEY----- XXX -----END PRIVATE KEY----- "
            },
            {
              "name": "cert_file_content",
              "type": "string",
              "required": false,
              "description": "The KMIP certificate file content, can be used for authentication.",
              "example": "-----BEGIN CERTIFICATE----- XXX -----END CERTIFICATE----- "
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<restore_encryption_password_kmip-response>\n    <status type=\"integer\">0</status>\n</restore_encryption_password_kmip-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/clear_encryption",
          "method": "DELETE",
          "description": "Remove any encryption configured on your VPSA.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<remove_encryption_password-response>\n    <status type=\"integer\">0</status>\n</remove_encryption_password-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/show_audit_config",
          "method": "GET",
          "description": "Gets the current file access auditing configuration for the vpsa.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-audit-config-response>\n  <status type=\"integer\">0</status>\n  <audit-configuration>\n          <enabled>NO</enabled>\n          <connect>NO</connect>\n          <create>NO</create>\n          <open-file>NO</open-file>\n          <rename>NO</rename>\n          <remove>NO</remove>\n          <attributes>NO</attributes>\n          <pool-name>pool-00010001</pool-name>\n          <obs-destination-name/>\n          <obs-destination-display-name/>\n  </audit-configuration>\n</show-audit-config-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"audit_configuration\": {\n      \"enabled\": \"NO\",\n      \"connect\": \"NO\",\n      \"create\": \"NO\",\n      \"open_file\": \"NO\",\n      \"rename\": \"NO\",\n      \"remove\": \"NO\",\n      \"attributes\": \"NO\",\n      \"pool_name\": \"pool-00010001\",\n      \"obs_destination_name\": null,\n      \"obs_destination_display_name\": null\n    }\n  }\n}"
        },
        {
          "uri": "/settings/configure_file_access_audit",
          "method": "POST",
          "description": "Enable or resume file access auditing configuration for the vpsa.",
          "parameters": [
            {
              "name": "audit_enable",
              "type": "string",
              "required": true,
              "description": "Value should be 'YES' to enable file access auditing.",
              "example": "YES"
            },
            {
              "name": "audit_vol_pool_name",
              "type": "string",
              "required": true,
              "description": "The pool name for the auditing volume.",
              "example": "pool-00010003"
            },
            {
              "name": "obs_dest",
              "type": "string",
              "required": false,
              "description": "ID of remote object storage destination.",
              "example": "obsdst-00000001"
            },
            {
              "name": "operations",
              "type": "string",
              "required": true,
              "description": "Names of file access operations to audit.",
              "example": "connect,create,open-file,rename,remove,attributes"
            },
            {
              "name": "force",
              "type": "string",
              "required": false,
              "description": "Use in case a confirmation is required.",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<config_audit_response>\n  <status type=\"integer\">0</status>\n</config_audit_response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/configure_file_access_audit",
          "method": "POST",
          "description": "Pause file access auditing configuration for the vpsa.",
          "parameters": [
            {
              "name": "audit_enable",
              "type": "string",
              "required": true,
              "description": "Value should be 'NO' to pause file access auditing.",
              "example": "NO"
            },
            {
              "name": "force",
              "type": "string",
              "required": false,
              "description": "Use in case a confirmation is required.",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<config_audit_response>\n  <status type=\"integer\">0</status>\n</config_audit_response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/disable_file_access_audit",
          "method": "POST",
          "description": "Disable file access auditing configuration for the vpsa.",
          "parameters": [
            {
              "name": "force",
              "type": "string",
              "required": false,
              "description": "Use in case a confirmation is required.",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/container_service",
          "method": "GET",
          "description": "Get the APP repository details.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-container-service-settings-response>\n  <status type=\"integer\">0</status>\n  <container-service-settings>\n    <enabled>YES</enabled>\n    <container-network>172.20.20.1/24</container-network>\n    <containers-running>NO</containers-running>\n    <ports>\n      <low type=\"integer\">9300</low>\n      <high type=\"integer\">9350</high>\n    </ports>\n    <created-at type=\"datetime\">2015-06-11T04:08:35+00:00</created-at>\n    <modified-at type=\"datetime\">2015-07-06T16:25:40+00:00</modified-at>\n    <images-repository>\n      <pool-name>pool-00000002</pool-name>\n      <pool-display-name>pool2</pool-display-name>\n    </images-repository>\n  </container-service-settings>\n</show-container-service-settings-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"container_service_settings\": {\n      \"enabled\": \"YES\",\n      \"container_network\": \"172.20.20.1/24\",\n      \"containers_running\": \"NO\",\n      \"ports\": {\n        \"low\": 9300,\n        \"high\": 9350\n      },\n      \"created_at\": \"2015-06-11 04:08:35 UTC\",\n      \"modified_at\": \"2015-07-06 16:25:40 UTC\",\n      \"images_repository\": {\n        \"pool_name\": \"pool-00000002\",\n        \"pool_display_name\": \"pool2\"\n      }\n    }\n  }\n}"
        },
        {
          "uri": "/settings/metering_db",
          "method": "GET",
          "redirection": "metering.zip",
          "description": "Download the metering database"
        },
        {
          "uri": "/settings/container_service",
          "method": "POST",
          "description": "Update the container service.",
          "parameters": [
            {
              "name": "lowport",
              "type": "integer",
              "required": true,
              "example": 9333
            },
            {
              "name": "highport",
              "type": "integer",
              "required": true,
              "description": null,
              "example": 9344
            },
            {
              "name": "containernetwork",
              "type": "string",
              "required": true,
              "description": null,
              "example": "172.20.20.1/24"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<update-container-service-settings-response>\n    <status type=\"integer\">0</status>\n</update-container-service-settings-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/create_images_repository",
          "method": "POST",
          "description": "Create the images repository.",
          "parameters": [
            {
              "name": "pool",
              "type": "string",
              "required": true,
              "description": "The pool where the images repository will be created",
              "example": "pool-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<create-images-repository-response>\n  <vol-name>volume-00000029</vol-name>\n  <status type=\"integer\">0</status>\n</create-images-repository-response>\n",
          "response_json": "{\n  \"response\": {\n    \"vol_name\": \"volume-00000029\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/migrate_images_repository",
          "method": "POST",
          "description": "Migrate the images repository.",
          "parameters": [
            {
              "name": "pool",
              "type": "string",
              "required": true,
              "description": "The destination pool",
              "example": "pool-00000001"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<migrate-images-repository-response>\n  <migration-job-name>mgrjob-00000005</migration-job-name>\n  <status type=\"integer\">0</status>\n</migrate-images-repository-response>\n",
          "response_json": "{\n  \"response\": {\n    \"migration_job_name\": \"mgrjob-00000005\",\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/images_repository",
          "method": "DELETE",
          "description": "Delete the images repository.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<delete-images-repository-response>\n    <status type=\"integer\">0</status>\n</delete-images-repository-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/trim_enable",
          "method": "POST",
          "description": "Enable volumes File System scheduling.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/trim_disable",
          "method": "POST",
          "description": "Disable volumes File System scheduling.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/trim_start",
          "method": "POST",
          "description": "Start volumes File System trim.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/trim_stop",
          "method": "POST",
          "description": "Stop volumes File System trim.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/default_write_policy",
          "method": "POST",
          "description": "Set Default Filesystem Write Policy.",
          "parameters": [
            {
              "name": "default_fs_write_policy",
              "type": "string",
              "options": "YES (Synchronous Writing), NO (Asynchronous Writing)",
              "example": "YES",
              "required": true,
              "description": "Default Filesystem Write Policy."
            },
            {
              "name": "apply_to_all_existing_filesystems",
              "type": "boolean",
              "example": true,
              "required": false,
              "description": "Apply To All Existing Filesystems."
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/defrag_enable",
          "method": "POST",
          "description": "Enable volumes defragmentation scheduling.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/defrag_disable",
          "method": "POST",
          "description": "Disable volumes defragmentation scheduling.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/defrag_start",
          "method": "POST",
          "description": "Start volumes defragmentation.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/defrag_stop",
          "method": "POST",
          "description": "Stop volumes defragmentation.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/enable_privilege_access",
          "method": "POST",
          "description": "Enable privilege access.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/disable_privilege_access",
          "method": "POST",
          "description": "Disable privilege access.",
          "parameters": [
            {
              "name": "password",
              "type": "string",
              "required": true,
              "description": "Emergency password",
              "example": "mysecretpassword"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n    <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/password_policy",
          "method": "POST",
          "description": "Set password policy.",
          "parameters": [
            {
              "name": "expire_password",
              "type": "boolean",
              "required": false,
              "description": "Enforce password expiration",
              "default": false
            },
            {
              "name": "expire_password_after",
              "type": "integer",
              "required": false,
              "description": "Expire passwords after (seconds), between 1296000 to 432000000 seconds (15 to 5000 days)"
            },
            {
              "name": "password_history",
              "type": "integer",
              "required": false,
              "description": "Number of passwords to remember, between 1 to 10",
              "default": 8
            },
            {
              "name": "min_password_length",
              "type": "integer",
              "required": false,
              "description": "Min password length, between 8 to 12",
              "default": 8
            },
            {
              "name": "password_must_contain_letters",
              "type": "boolean",
              "required": false,
              "description": "Password must contain letters",
              "default": true
            },
            {
              "name": "password_must_contain_numbers",
              "type": "boolean",
              "required": false,
              "description": "Password must contain numbers",
              "default": true
            },
            {
              "name": "password_must_contain_uppercase_letters",
              "type": "boolean",
              "required": false,
              "description": "Password must contain uppercase letters",
              "default": false
            },
            {
              "name": "password_must_contain_special_characters",
              "type": "boolean",
              "required": false,
              "description": "Password must contain special characters",
              "default": false
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <status type=\"integer\">0</status>\n  <status-msg>Updated</status-msg>\n</hash>\n",
          "response_json": "{\n  \"status\": 0,\n  \"status_msg\": \"Updated\"\n}"
        },
        {
          "uri": "/settings_config",
          "method": "GET",
          "description": "Get all application settings. Allowed to admin only.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <name>test</name>\n  <uuid>A449CFA51BC14B54B0482B7093DEB668</uuid>\n  <CloudUuid>C59AF4752A584EB4B9C69567D7FB8AE6</CloudUuid>\n  <url>https://vsa-0000005b-zadara.zadaravpsa.com</url>\n  <display-name>test</display-name>\n  <version>18.11-1</version>\n  <enterprise-suite>enabled</enterprise-suite>\n  <language>en</language>\n  <smb-ads>NO</smb-ads>\n  <cpu-usage-alert type=\"integer\">95</cpu-usage-alert>\n  <mem-usage-alert type=\"integer\">90</mem-usage-alert>\n  <cpu-docker-usage-alert type=\"integer\">95</cpu-docker-usage-alert>\n  <mem-docker-usage-alert type=\"integer\">95</mem-docker-usage-alert>\n  <multi-zone>NO</multi-zone>\n  <afa>NO</afa>\n  <io-engine>400</io-engine>\n  <io-vcpus type=\"integer\">2</io-vcpus>\n  <io-ram-mb type=\"integer\">6144</io-ram-mb>\n  <app-engine>00</app-engine>\n  <app-vcpus type=\"integer\">0</app-vcpus>\n  <app-ram-mb type=\"integer\">0</app-ram-mb>\n  <wwnn nil=\"true\"/>\n  <smb-netbios-name>vsa-0000005b</smb-netbios-name>\n  <defrag-enable>enabled</defrag-enable>\n  <defrag-runtime>168</defrag-runtime>\n  <defrag-active>0</defrag-active>\n  <defrag-volumes-processed>0</defrag-volumes-processed>\n  <defrag-volumes-pending>0</defrag-volumes-pending>\n  <defrag-elapsed-time-sec>0</defrag-elapsed-time-sec>\n  <base-cache-gb type=\"integer\">20</base-cache-gb>\n  <ext-cache-gb type=\"integer\">0</ext-cache-gb>\n  <volume-default-mount-sync>NO</volume-default-mount-sync>\n  <volume-default-atime-update>YES</volume-default-atime-update>\n  <last-vpsa-request>change_model</last-vpsa-request>\n  <vpsa-request-status>Completed</vpsa-request-status>\n  <pool-types-count type=\"integer\">3</pool-types-count>\n  <pool-types type=\"array\">\n    <pool-type>Transactional Workloads</pool-type>\n    <pool-type>Repository Storage</pool-type>\n    <pool-type>Archival Storage</pool-type>\n  </pool-types>\n  <smb-charset-count type=\"integer\">2</smb-charset-count>\n  <smb-charsets type=\"array\">\n    <smb-charset>UTF-8</smb-charset>\n    <smb-charset>ISO-8859-1</smb-charset>\n  </smb-charsets>\n  <iscsi-on-public-ip>YES</iscsi-on-public-ip>\n  <admin-access-enabled>yes</admin-access-enabled>\n  <is-support-privilege-access-enabled>YES</is-support-privilege-access-enabled>\n  <created-at>2019-04-07T10:11:19+0300</created-at>\n  <modified-at>2019-04-07T10:24:03+0300</modified-at>\n  <service-mode>0</service-mode>\n  <expire-password>0</expire-password>\n  <expire-password-after>7776000</expire-password-after>\n  <min-password-length>8</min-password-length>\n  <password-must-contain-letters>1</password-must-contain-letters>\n  <password-must-contain-numbers>1</password-must-contain-numbers>\n  <password-must-contain-uppercase-letters>0</password-must-contain-uppercase-letters>\n  <password-must-contain-special-characters>0</password-must-contain-special-characters>\n  <password-requirements-text>should contain numbers and letters</password-requirements-text>\n  <password-history>8</password-history>\n  <legacy-otp-secret>0</legacy-otp-secret>\n  <vpsa-chap-user>test</vpsa-chap-user>\n  <vpsa-chap-secret>pass</vpsa-chap-secret>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"name\": \"test\",\n    \"uuid\": \"A449CFA51BC14B54B0482B7093DEB668\",\n    \"CloudUuid\": \"C59AF4752A584EB4B9C69567D7FB8AE6\",\n    \"url\": \"https://vsa-0000005b-zadara.zadaravpsa.com\",\n    \"display_name\": \"test\",\n    \"version\": \"18.11-1\",\n    \"enterprise_suite\": \"enabled\",\n    \"language\": \"en\",\n    \"smb_ads\": \"NO\",\n    \"cpu_usage_alert\": 95,\n    \"mem_usage_alert\": 90,\n    \"cpu_docker_usage_alert\": 95,\n    \"mem_docker_usage_alert\": 95,\n    \"multi_zone\": \"NO\",\n    \"afa\": \"NO\",\n    \"io_engine\": \"400\",\n    \"io_vcpus\": 2,\n    \"io_ram_mb\": 6144,\n    \"app_engine\": \"00\",\n    \"app_vcpus\": 0,\n    \"app_ram_mb\": 0,\n    \"wwnn\": null,\n    \"smb_netbios_name\": \"vsa-0000005b\",\n    \"defrag_enable\": \"enabled\",\n    \"defrag_runtime\": \"168\",\n    \"defrag_active\": \"0\",\n    \"defrag_volumes_processed\": \"0\",\n    \"defrag_volumes_pending\": \"0\",\n    \"defrag_elapsed_time_sec\": \"0\",\n    \"base_cache_gb\": 20,\n    \"ext_cache_gb\": 0,\n    \"volume_default_mount_sync\": \"NO\",\n    \"volume_default_atime_update\": \"YES\",\n    \"last_vpsa_request\": \"change_model\",\n    \"vpsa_request_status\": \"Completed\",\n    \"pool_types\": [\n      \"Transactional Workloads\",\n      \"Repository Storage\",\n      \"Archival Storage\"\n    ],\n    \"smb_charset_count\": 2,\n    \"smb_charsets\": [\n      \"UTF-8\",\n      \"ISO-8859-1\"\n    ],\n    \"iscsi_on_public_ip\": \"YES\",\n    \"admin_access_enabled\": \"yes\",\n    \"is_support_privilege_access_enabled\": \"YES\",\n    \"created_at\": \"2019-04-07T10:11:19+0300\",\n    \"modified_at\": \"2019-04-07T10:24:03+0300\",\n    \"service_mode\": \"0\",\n    \"expire_password\": \"0\",\n    \"expire_password_after\": \"7776000\",\n    \"min_password_length\": \"8\",\n    \"password_must_contain_letters\": \"1\",\n    \"password_must_contain_numbers\": \"1\",\n    \"password_must_contain_uppercase_letters\": \"0\",\n    \"password_must_contain_special_characters\": \"0\",\n    \"password_requirements_text\": \"should contain numbers and letters\",\n    \"password_history\": \"8\",\n    \"legacy_otp_secret\": \"0\",\n    \"vpsa_chap_user\": \"test\",\n    \"vpsa_chap_secret\": \"pass\",\n    \"count\": 3\n  }\n}"
        },
        {
          "uri": "/settings/set_mtu",
          "method": "POST",
          "description": "Changes the MTU for a network interface.",
          "parameters": [
            {
              "name": "fe_mtu",
              "type": "string",
              "description": "An MTU value for the frontend interface",
              "options": "1450, 1500, 2048, 4096, 9000",
              "example": 1500
            },
            {
              "name": "public_mtu",
              "type": "string",
              "description": "An MTU value for the public interface",
              "options": "1450, 1500, 2048, 4096, 9000",
              "example": 1500
            },
            {
              "name": "force",
              "desciption": "Force MTU change despite affect on current sessions",
              "type": "string",
              "options": "YES, NO",
              "example": "YES"
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<set-mtu-response>\n  <status type=\"integer\">0</status>\n</set-mtu-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/settings/server_monitoring",
          "method": "POST",
          "description": "Set global server connectivity monitoring",
          "parameters": [
            {
              "name": "status",
              "type": "string",
              "description": "Server connectivity status",
              "options": "enable, silent, disable",
              "example": "enable"
            },
            {
              "name": "pings",
              "type": "integer",
              "description": "Connection attempts (between 1 to 100)",
              "example": 10
            },
            {
              "name": "success",
              "type": "integer",
              "description": "Success threshold (between 1 to 100)",
              "example": 6
            }
          ],
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status type=\"integer\">0</status>\n</response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0\n  }\n}"
        },
        {
          "uri": "/vc_capabilities",
          "method": "GET",
          "description": "Returns a list of all VC capabilities.",
          "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<show-vc-capabilities-response>\n  <status type=\"integer\">0</status>\n  <vc-capabilities type=\"array\">\n    <vc-capability>app_engine</vc-capability>\n    <vc-capability>large_ssd_cache_support</vc-capability>\n    <vc-capability>setup_partition_handled</vc-capability>\n    <vc-capability>ssd_setup_supported</vc-capability>\n    <vc-capability>scheduled_upgrade</vc-capability>\n    <vc-capability>update_settings</vc-capability>\n    <vc-capability>archival_pool</vc-capability>\n    <vc-capability>change_with_upgrade</vc-capability>\n    <vc-capability>zadarastorage_cert_support</vc-capability>\n    <vc-capability>vni_enabled</vc-capability>\n    <vc-capability>mag</vc-capability>\n    <vc-capability>scheduled_failover</vc-capability>\n    <vc-capability>connectx_5_support</vc-capability>\n    <vc-capability>scheduled_zsnap</vc-capability>\n    <vc-capability>explicit_public_ip</vc-capability>\n    <vc-capability>asigra_support</vc-capability>\n    <vc-capability>internet_access_toggle_support</vc-capability>\n    <vc-capability>sn_rename_support</vc-capability>\n    <vc-capability>upgrade_from_versions_19.08_20.01</vc-capability>\n    <vc-capability>external_cg_snapshot_support</vc-capability>\n  </vc-capabilities>\n</show-vc-capabilities-response>\n",
          "response_json": "{\n  \"response\": {\n    \"status\": 0,\n    \"vc_capabilities\": [\n      \"app_engine\",\n      \"large_ssd_cache_support\",\n      \"setup_partition_handled\",\n      \"ssd_setup_supported\",\n      \"scheduled_upgrade\",\n      \"update_settings\",\n      \"archival_pool\",\n      \"change_with_upgrade\",\n      \"zadarastorage_cert_support\",\n      \"vni_enabled\",\n      \"mag\",\n      \"scheduled_failover\",\n      \"connectx_5_support\",\n      \"scheduled_zsnap\",\n      \"explicit_public_ip\",\n      \"asigra_support\",\n      \"internet_access_toggle_support\",\n      \"sn_rename_support\",\n      \"upgrade_from_versions_19.08_20.01\",\n      \"external_cg_snapshot_support\"\n    ]\n  }\n}"
        }
      ]
    }
  ],
  "intro": "<h2 id=\"overview\">Overview</h2>\n\n<p>This document outlines the methods available for administrating your Zadara Storage VPSA™.  The Zadara Storage Array REST API supports form-encoded, JSON, and XML requests, and can return either JSON or XML responses.</p>\n\n<h2 id=\"usage\">Usage</h2>\n\n<p>The majority of the APIs available require authentication which requires an API token to use.  You can retrieve this token through the Users section of your VPSA, or through the API using the “Return a user’s access key” API in the <a href=\"#users\">Users Section</a> below.</p>\n\n<h2 id=\"auth_methods\">Authentication Methods</h2>\n\n<p>The authentication token can be passed either through the <code>access_key</code> parameter inside of the body of the REST API request, or through the <code>X-Access-Key</code> header.</p>\n\n<h2 id=\"timeouts\">Timeouts</h2>\n\n<p>By default, all operations that don’t complete within five seconds will return a message informing you that the action may take some time to complete.  When using the API, this can cause some actions, such as large volume creation, to be undesirably asynchronous.  You can specify your own timeout with the <code>timeout</code> parameter, in seconds, and a timeout value of -1 specifies an infinite timeout.</p>\n\n<h2 id=\"specific_fields_for_product\">Specific Fields For Product</h2>\n\n<p>Some of the fields/actions used in the API should be used only for a specific product. The following tags are used to mark which product responds to the fields/actions</p>\n\n<div><span class=\"badge badge-danger badge-xs\">VPSA Flash Array</span> - All Flash Array VPSA</div>\n<div><span class=\"badge badge-danger badge-xs\">VPSA Storage Array</span> - Hybrid VPSA</div>\n\n<h3>Questions</h3>\n\n<p>If you have any questions or need support involving the REST API, please contact <a href=\"mailto:support@zadarastorage.com\">support@zadarastorage.com</a> for assistance.</p>\n"
};