Go to main content

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

Exit Print View

Updated: December 2017
 
 

Get Service Commands

The get service command returns information about that service, including a list of all the available commands.

Example Request:

GET /api/appliance/v1 HTTP/1.1
Host: zfs-storage.example.com
X-Auth-Session: guigqpQRE4g89ngb

Example Response:

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

{
    "service": {
        "name": "appliance",
        "methods": [
            {
                "description": "Get appliance RESTful services",
                "path": "/apis",
                "request": "GET"
            },
            {
                "description": "Get appliance RESTful service properties",
                "path": "/apis/<api:path>",
                "request": "GET"
            },
            {
                "description": "Create a new alert threshold watch",
                "path": "/alerts/thresholds",
                "request": "POST"
            }, ... ]
    }
}