API Documentation

Introduction

Welcome to the Service Watch API documentation. This guide will help you get started with integrating our services into your applications.

The base URL for all requests is https://servicewatch.xyz/api/

Authentication

To use our API, you'll need to authenticate your requests by passing your API key as a header.

Authorization: Token <YOUR-API-KEY>

Sentinel Heartbeat

This endpoint allows you to ping a sentinel from your application.

POST /heartbeat/<SENTINEL-ID>/
curl -X POST https://servicewatch.xyz/api/heartbeat/<SENTINEL-ID> -H "Authorization: Token <YOUR-API-KEY>"
                                        
import requests

headers = {"Authorization": "Token <YOUR-API-KEY>"}
response = requests.post("https://servicewatch.xyz/api/heartbeat/<SENTINEL-ID>", headers=headers)
print(response.json())