Hawk Host Status

Services API

Each service has a log of all events that have occured in the past. The current state of a service is represented by the current status of the service.

Attributes

id
The unique identifier by which to identify the service>
name
The name of the service, defined by the user
description
The description of the web service
service-list
The service list this service belongs to, if any
current-event
The current event for the service, if any
url
URL of this resource

List all the services

GET /api/v1/services
{
    "services": [
        {
            "name": "Example Foo",
            "id": "example-foo",
            "list": null,
            "description": "An explanation of this service"
            "url": "/api/v1/services/example-foo",
            "current-event": {
                'message': 'What an event!',
                'sid': 'ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GA8M',
                'status': {
                    'description': 'Hey, dude',
                    'id': 'up',
                    'image': '/images/status/tick-circle.png',
                    'level': 'NORMAL',
                    'name': 'Up',
                    'url': '/statuses/up'
        },
                'timestamp': 'Mon, 28 Jun 2010 22:17:06 GMT',
                'url': '/services/twilio/events/ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GA8M'},

        },
        {
            "name": "Example Bar",
            "id": "example-bar",
            "description": "An explanation of this service"
            "url": "/api/v1/services/example-bar",
            "current-event": null,
        }
    ]
}

Get a single service

GET /api/v1/services/{service-id}
{
    "name": "Example Service",
    "id": "example-service",
    "description": "An explanation of what this service represents",
    "list": {
        "name": "Example List",
        "id": "example-list",
        "description": "System is now operational",
        "url": "/api/v1/service-lists/example-list"
    },
    "url": "/api/v1/services/example-service",
    "current-event": null
}