REST API

Zephyr REST API documentation

Overview

Zephyr REST API provides access to Zephyr's internal data. This API is currently read only.

Zephyr runs on port 3753. This value is currently not configurable.

All responses contain the header X-Zephyr-Api-Version which represents the API's version code. This version is also available via the GET /api/version endpoint.

Version

GET http://localhost:3753/api/version

Get Zephyr version info and configuration.

200 Zephyr version info and configuration

{
    "api": 1,
    "desktop": "2.0.8",
    "node": "v8.9.3",
    "buildType": "Steam",
    "config": {
        "type": "steam",
        "enableUpdates": false,
        "port": 3753,
        "enableOverlay": true
    },
    "features": [
        "POST_NOTIFICATIONS",
        "DISMISS_NOTIFICATIONS",
        "UPDATE_NOTIFICATIONS"
    ],
    "socketChannels": {
        "actions":{
            "postNotification": "post-notification",
            "dismissNotification": "dismiss-notification",
            "disconnect": "disconnect"
        },
        "events":{
            "notificationPosted": "event-post-notification",
            "notificationDismissed": "event-dismiss-notification"
        }
    }
}

Notifications

GET http://localhost:3753/api/notifications

Get list of notifications sent to Zephyr within the current session.

200 List of notifications

[
    {
        "packageName": "com.example.app",
        "id": 35243,
        "timestamp": "1556682824",
        "title": "New message",
        "body": "Hey! How are you?",
        "icon:": "<base64 encoded image>"
    }
]