Help en handleidingenAPI en integraties › API endpoints overzicht

API endpoints overzicht

5 min leestijd · API en integraties

Overzicht van alle beschikbare API-endpoints (de afzonderlijke URL's van de REST API die je aanroept). Basis-URL: https://epulz.io/api/v1

Autorisatie: stuur de header Authorization: Bearer epulzio_.... De aanvraaglimiet (rate limit) is 60 aanvragen per minuut per token. Een token genereer je in Instellingen -> API-tokens.

Beheer van API-tokens voor toegang tot de REST API
Het token voor API-aanroepen maak en beheer je in het gedeelte API-tokens.

Status / tokencontrole

  • GET /status - verifieert het token, geeft het e-mailadres, het abonnement, het aantal monitors en het aantal open incidenten terug.

Monitors

  • GET /monitors - lijst van al je monitors (inclusief beschikbaarheid van de laatste 24 h).
  • GET /monitors/{id} - detail van één monitor.
  • POST /monitors - maakt een nieuwe monitor aan. Stuur in de body van de aanvraag (JSON) de velden name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
  • POST /monitors/bulk - bulkimport (maximaal 200 monitors in één aanvraag).
  • PATCH /monitors/{id} - wijziging van een bestaande monitor (stuur alleen de velden die je wilt wijzigen).
  • POST /monitors/{id}/check - voert een directe controle uit buiten het geplande interval; geeft de bijgewerkte monitor terug.
  • GET /monitors/{id}/uptime?days=30 - beschikbaarheid in % over de laatste N dagen (1-365, standaard 30); onderhoudsvensters worden uitgesloten.
  • DELETE /monitors/{id} - verwijdert de monitor (samen met de geschiedenis van controles en incidenten).

Controles (geschiedenis)

  • GET /monitors/{id}/checks?limit=100 - de laatste N controles van een monitor (status, responstijd, HTTP status code, eventuele fout, regio). De parameter limit kan 1 tot 500 zijn, standaard 50.

Incidenten

  • GET /incidents - lijst van incidenten. Optionele filters: monitor_id, resolved (true/false), limit (1-500, standaard 50).

Foutcodes

  • 401 - ontbrekend of ongeldig token.
  • 403 - monitorlimiet van je abonnement overschreden (bij het aanmaken).
  • 404 - de monitor is niet van jou of bestaat niet.
  • 429 - aanvraaglimiet overschreden (60 per minuut per token).

Machineleesbare documentatie

De volledige specificatie in de OpenAPI-standaard is beschikbaar op /api/openapi.json. De interactieve documentatie, waar je de endpoints direct kunt uitproberen (Swagger UI), vind je op /api/docs. Beide vereisen een aanmelding of een geldig token.

Was deze handleiding nuttig?