Opmerking: Met ingang van 27 augustus 2025 worden sommige velden in de eindpunten GET en POST /Monitor en GET, PUT en PATCH /Monitor/{monitorGuid} verwijderd. Raadpleeg de API changelog voor meer informatie.
Overzicht
De Monitor API biedt een set eindpunten om uw controleregelinstellingen en -configuratie te beheren.
Gebruiksvoorbeelden
Gebruik de Monitor API om:
- Controleregels en hun configuratie te beheren — controleregels creëren, bijwerken, klonen en verwijderen, en toegang tot hun instellingen (controleregeldefinitie, gebruikersrechten en onderhoudsperiodes) regelen.
- Onderhoudsperiodes te plannen — plan en beheer onderhoudsperiodes om valse alerts tijdens geplande downtime te voorkomen.
- Controleregeldefinities in bulk te bekijken — controleer realtime controleregeldefinities allemaal tegelijk voor analyse en rapportage.
Vereisten
Voordat u de Monitor API gebruikt, moet u ervoor zorgen dat u beschikt over:
- Uptrends API-inloggegevens
- De juiste gebruikersrechten om controleregels in uw Uptrends-account te beheren.
- Een basiskennis van uw monitoringvereisten en de controleregel- instellingen die u moet configureren.
Monitor API-velden
Wanneer u met de Monitor API-eindpunten werkt, bevat het controleregelobject verschillende API-velden die kunnen variëren afhankelijk van het controleregeltype en de configuratie. Deze velden zijn onder andere de MonitorGuid, MonitorType, GenerateAlert, IsActive.
Raadpleeg het artikel Monitor API-velden voor een volledige lijst met beschikbare API-velden.
Monitor API-eindpunten
De Monitor API biedt de volgende eindpunten voor het beheer van uw controleregels:
Controleregels beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Monitor |
Haal een lijst op van alle controleregels en hun configuratie, met opties om specifieke velden te filteren. |
POST |
/Monitor |
Creëer een nieuwe controleregel met de gegeven configuratie. |
GET |
/Monitor/{monitorGuid} |
Haal een controleregel en zijn configuratie op via controleregel-ID. |
PATCH |
/Monitor/{monitorGuid} |
Werk de geselecteerde velden van een controleregel bij. |
PUT |
/Monitor/{monitorGuid} |
Werk alle velden van een controleregel bij. |
DELETE |
/Monitor/{monitorGuid} |
Verwijder de gespecificeerde controleregel uit uw account. |
POST |
/Monitor/{monitorGuid}/Clone |
Creëer een duplicaat-controleregel met identieke configuratie-instellingen (URL, controle-intervallen, alertinstellingen en andere), maar met een nieuwe, unieke controleregel-ID. De gekloonde controleregel is aanvankelijk ingesteld op inactief, zodat u de configuratie kunt wijzigen voordat u hem inschakelt. |
Controleregels beheren per controleregelgroep
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MonitorGroup/ |
Haal de GUID’s op van controleregelgroepen waarvan de gespecificeerde controleregel lid is. |
GET |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Haal controleregels en hun configuraties op op basis van de gespecificeerde controleregelgroep-GUID, met optionele veldfilters. |
POST |
/Monitor/MonitorGroup/{monitorGroupGuid} |
Creëer een controleregel met de gegeven configuratie en voeg deze toe aan de gespecificeerde controleregelgroep. |
Onderhoudsperiodes voor controleregels beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Monitor/{monitorGuid}/MaintenancePeriod |
Haal alle geplande onderhoudsperiodes op voor de gespecificeerde controleregel.
|
PUT |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Werk de geplande onderhoudsperiode bij voor de gespecificeerde controleregel.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod |
Plan een nieuwe onderhoudsperiode voor de gespecificeerde controleregel.
|
DELETE |
/Monitor/{monitorGuid}/MaintenancePeriod/{maintenancePeriodId} |
Verwijder een geplande onderhoudsperiode uit de gespecificeerde controleregel.
|
POST |
/Monitor/{monitorGuid}/MaintenancePeriod/CleanUp/{beforeDate} |
Verwijder alle eenmalige onderhoudsperiodes uit de gespecificeerde controleregel vóór de gespecificeerde datum.
|
Controleregelrechten beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Monitor/{monitorGuid}/Authorizations |
Haal alle controleregelrechten op die zijn gekoppeld aan de gespecificeerde controleregel.
|
POST |
/Monitor/{monitorGuid}/Authorizations |
Voeg controleregelrechten toe aan de gespecificeerde controleregel. Door een recht te verlenen, worden automatisch alle vereiste gebruikersrechten voor dat recht toegevoegd.
|
DELETE |
/Monitor/{monitorGuid}/Authorizations/{authorizationGuid} |
Verwijder het controleregelrecht dat is gekoppeld aan gespecificeerde controleregel.
|
Raadpleeg de Uptrends Monitor API-documentatie voor gedetailleerde request - en responseformaten en interactieve API-tests.
Probleemoplossing
Deze sectie behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de Monitor API.
Veelvoorkomende fouten
Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:
| Statuscode | Beschrijving |
|---|---|
| 200 | OK — request succesvol |
| 204 | No content — de request is succesvol voltooid en er is geen response geretourneerd. Dit geldt voor DELETE, PUT, PATCH en POST requests. |
| 400 | Bad request — ongeldige requestparameters of ontbrekende verplichte velden. |
| 401 | Unauthorized — ongeldige of ontbrekende authenticatiegegevens. |
| 403 | Forbidden — toestemming geweigerd. |
| 404 | Not Found — de opgegeven GUID bestaat niet. |
| 500 | Internal Server Error — er is een serverfout opgetreden. |
Algemene handleiding voor probleemoplossing
Zorg ervoor dat u:
- Altijd uw request data valideert voordat u API-calls verstuurt.
- Voor elke operation de juiste HTTP-methoden gebruikt.
Neem voor verdere ondersteuning contact op met ons Support-team.
Aanvullende artikelen
Raadpleeg de volgende artikelen voor meer informatie:
- Uptrends Monitor API-documentatie — een interactieve API-documentatie met gedetailleerde eindpuntspecificaties.
- Monitor API-velden — een lijst met alle beschikbare Monitor API-velden.
- MonitorCheck API — retourneert gedetailleerde resultaten van individuele controleregelchecks.
- MonitorGroup API — retourneert gedetailleerde informatie over controleregelgroepen.
- API changelog — voor de laatste API-updates en meldingen over verouderde API’s.