API Endpoints

The Pulsetic API provides a structured way to programmatically interact with your monitoring data and configurations. This guide details the available endpoints in the Pulsetic API. Developers can use these endpoints to integrate Pulsetic's monitoring data into their own applications.

Base URL and Authentication

Base URL

All Pulsetic API requests should be directed to the following base URL: https://api.pulsetic.com/api/public

Authentication

Access to the Pulsetic API is secured using an API token. This token must be included in the header of every API request.

• Header Name: Authorization
• Header Value: Your unique API token.

Monitor Management Endpoints

List Monitors

• GET /monitors : Retrieves a list of all configured monitors.

Create Monitor

• POST /monitors : Creates a new monitor.

Get Specific Monitor

• GET /monitors/{id} : Retrieves detailed information for the monitor with the specified {id} .

Update Monitor

• PUT /monitors/{id} : Updates the configuration of the monitor with the specified {id} .

Delete Monitor

• DELETE /monitors/{id} : Deletes the monitor with the specified {id} .

Get Monitor Snapshots

• GET /monitors/{id}/snapshots : Retrieves point-in-time status snapshots for the monitor with the specified {id} . Supports start_dt and end_dt query parameters for filtering by time range.

Get Monitor Checks

• GET /monitors/{id}/checks : Retrieves historical monitoring check results for the monitor with the specified {id} . Supports start_dt , end_dt , nodes[] (filter by location), and response_codes[] (filter by HTTP response code) query parameters.

Get Monitor Events

• GET /monitors/{id}/events : Retrieves events (e.g., online/offline transitions) for the monitor with the specified {id} . Supports start_dt , end_dt , and monitor_event_type (e.g., Online , Offline ) query parameters for filtering.

Get Monitor Downtime

• GET /monitors/{id}/downtime : Retrieves the total downtime in seconds for the monitor with the specified {id} . The seconds query parameter can optionally specify a time window in seconds (default is 3600 seconds).

Status Page Management Endpoints

List Status Pages

• GET /status-page : Retrieves a list of all configured status pages.

Create Status Page

• POST /status-page : Creates a new status page.

Get Specific Status Page

• GET /status-page/{id} : Retrieves detailed information for the status page with the specified {id} .

Update Status Page

• PUT /status-page/{id} : Updates the configuration of the status page with the specified {id} .

Delete Status Page

• DELETE /status-page/{id} : Deletes the status page with the specified {id} .

Status Page Maintenance Endpoints

Add Maintenance Event

• POST /status-page/{id}/maintenance : Adds a new maintenance event to the status page with the specified {id} .

Update Maintenance Event

• PUT /status-page/maintenance/{maintenance_id} : Updates the maintenance event with the specified {maintenance_id} .

Delete Maintenance Event

• DELETE /status-page/maintenance/{maintenance_id} : Deletes the maintenance event with the specified {maintenance_id} .

Status Page Incident Endpoints

Add Incident

• POST /status-page/{id}/incidents : Adds a new incident to the status page with the specified {id} .

Update Incident

• PUT /status-page/incidents/{incident_id} : Updates the incident with the specified {incident_id} .

Delete Incident

• DELETE /status-page/incidents/{incident_id} : Deletes the incident with the specified {incident_id} .

Status Page Incident Update Endpoints

Add Incident Update

• POST /incidents/{incident_id}/incident-update : Adds a new update to the incident with the specified {incident_id} .

Update Incident Update

• PUT /incidents/updates/{update_id} : Updates the incident update with the specified {update_id} .

Delete Incident Update

• DELETE /incidents/updates/{update_id} : Deletes the incident update with the specified {update_id} .

List Status Page Incidents

• GET /status-page/{id}/incidents : Retrieves a list of incidents for the status page with the specified {id} .

For more information, see the API Usage Examples.