Hawk Host Status

Service Lists API

Services are often grouped into collections of related services.

Attributes

id
The unique identifier by which to identify the list
name
The name of the list, defined by the user
description
The description of the list
url
The URL of the specific list resource

List all service lists

GET /api/v1/service-lists
{
    "lists": [
        {
            "name": "Example Foo",
            "id": "example-foo",
            "description": "An explanation of this service"
            "url": "/api/v1/service-lists/example-foo",
        },
        {
            "name": "Example Bar",
            "id": "example-bar",
            "description": "An explanation of this service"
            "url": "/api/v1/service-lists/example-bar",
        }
    ]
}

Get a single service list

GET /api/v1/service-lists/{service_list_id}
{
    "name": "Example List",
    "id": "example-list",
    "description": "An explanation of what this list represents"
    "url": "/api/v1/service-lists/example-list",
}