Go to main content

Oracle® ZFS Storage Appliance RESTful API Guide, Release OS8.7.x

Exit Print View

Updated: December 2017
 
 

List Services

The list services command lists the available service access URIs. If a login session is not desired, list services can be used with appropriate credentials to list the available service access URIs. This command lists all the RESTful API services and versions available on the appliance.

Example Request:

GET /api/access/v1 HTTP/1.1
Host: zfs-storage.example.com
X-Auth-User: joeadmin
X-Auth-Key: letmein

Example Result:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 190
X-Zfssa-Access-Api: 1.0

{
    "access": {
        "services": [{
            "version": "1.0",
            "name": "appliance",
            "uri": "https://zfs-storage.example.com:215/api/appliance/v1"
        }, {
            "version": "1.0",
            "name": "nas",
            "uri": "https://zfs-storage.example.com:215/api/nas/v1"
        }, {
            "version": "1.0",
            "name": "replication",
            "uri": "https://zfs-storage.example.com:215/api/replication/v1"
        }, {
            "version": "1.0",
            "name": "san",
            "uri": "https://zfs-storage.example.com:215/api/san/v1"
        } ... ]
    }
}