GET Syntax Details

GET https://<array_name>:<port_number>/<version_number>/<object_set><addition_query_parameter><query_parameter>

Note:

<array_name> = array management IP address or fully qualified domain name (FQDN)
<port_number> = 5392
<version_number> = v1
<object_set> = supported object set name, such as volumes
<qualifiers> = optional parameters, such as /detail to show verbose details about an object set, /<ID> to narrow down an object set results to only one object.
<query_parameter> = the ? character appened to <object_set_name> or <query_parameter> to filter for specific rows or fields.

Examples:

Return a list of volumes:

GET https://<array_name>:5392/v1/volumes

Expected output:
{ "data": [ { "id": "0600000000000004d3000000000000000000000001", "name": "myvol1" } ], "endRow": 1, "startRow": 0, "totalRows": 1 }
Return verbose details for all volumes in the array:

GET https://<array_name>:5392/v1/volumes/detail

Expected output:
Retrieve information on a specific volume of interest, with the volume ID of “060df0fe6f7dc7bb160000000000000000000001be” as input:

GET https://<array_name>.com:5392/v1/volumes/060df0fe6f7dc7bb160000000000000000000001be

Expected output:
Return specific range of rows from output:

Note: startRow is inclusive of the first row, which starts with “0”, and endRow is exclusive. For example, startRow=1 & endRow=3 will return the second and third rows of the API GET method.

GET https://<array_name>:5392/v1/volumes?startRow=1&endRow=3

Expected output:
Select specific fields of interests from object set, and sort by a particular field (could be more than one field):

GET https://<array_name>:5392/v1/volumes/details?fields=id,name&sortBy=name

Expected output:
Filter object set based on specific field:

GET https:// <array_name>:5392/v1/volumes?name=myvol1

Expected output:

For details, see cURL Code Sample.