Uptrends API versie 4 is een uitgebreide set eindpunten waarmee u met de Uptrends-webapplicatie kunt communiceren via API-calls. Gebruik de API voor:
- Toegang tot realtime monitoringdata om de performance van website en webservice te volgen.
- Het ophalen van performancedata, uptimestatistieken en historische data voor analyse en rapportage.
- Het beheren van alerts, accountinstellingen, gebruikersrechten en controleregelconfiguraties.
- Het bouwen van scripts om controleregels te creëren, bij te werken en te verwijderen, en het beheren van configuraties voor monitoringinstellingen.
De meest recente informatie over API-wijzigingen en nieuwe functies vindt u in de API changelog.
Toegang tot de API
Om toegang te krijgen tot en gebruik te maken van de Uptrends API v4, moet u eerst een API-account aanmaken. Na het aanmaken zijn alle Uptrends API-eindpunten beschikbaar op de Uptrends API v4-documentatie. Deze interactieve documentatie beschrijft alle API-methoden uitvoerig en biedt een testomgeving waar u API-calls direct kunt uitproberen en uitvoeren.
Daarnaast kunt u onze Swagger-specificatie gebruiken met Swagger Codegen om clientcode te genereren en de Uptrends API te integreren in uw scripts of applicaties. Raadpleeg Swagger.io voor meer informatie over Swagger en de bijbehorende tools.
API-eindpunten
De volgende API-eindpunten worden momenteel ondersteund:
Account API
De Account API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van accountinformatie en abonnementsgegevens. U heeft toegang tot accountdata, waaronder factuurgegevens en gebruiksstatistieken, om uw Uptrends-abonnement en resourceverbruik te monitoren.
U heeft toegang tot gegevens zoals accountvervaldatums, creditverbruik per controleregeltype en operator-aantallen binnen uw account.
Alert API
De Alert API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van alertinformatie van specifieke controleregels of controleregelgroepen. U heeft toegang tot alertdata, waaronder alert-tijdstempels, alerttypes, foutbeschrijvingen en getroffen controleregels, om problemen en onderbrekingen van uw webservices in realtime effectief te volgen.
Raadpleeg Alert API voor meer informatie.
Alert definitions API
De Alertdefinities API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van alertdefinities die op basis van escalatieniveaus specificeren hoe alerts worden verzonden en wie ze ontvangt. U heeft toegang tot details zoals alertdefinitienamen en hun status om ervoor te zorgen dat alerts effectief worden beheerd.
Raadpleeg voor meer informatie Alert definition API.
Checkpoint API
De Checkpoint API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van controlestationlocaties of -servers die de daadwerkelijke monitoring vanaf specifieke locaties uitvoeren.
U heeft toegang tot controlestationdata zoals de naam en locatiecode van het controlestation, hoge beschikbaarheid en de status van het primaire controlestation, IPv6-ondersteuningsmogelijkheden en geografische regio-informatie. U heeft ook toegang tot servergegevens, waaronder IPv4- en IPv6-adressen, die u kunt gebruiken voor whitelisting in uw firewall.
Hiermee kunt u netwerkconfiguraties controleren en uw websites en webservices op verschillende geografische locaties monitoren
Dashboard API
De Dashboard API biedt methoden voor het creëren, bijwerken en beheren van dashboardconfiguraties en de bijbehorende filterinstellingen. U kunt dashboardweergaven wijzigen om aangepaste monitoringweergaven te maken die voldoen aan uw specifieke vereisten.
U heeft toegang tot details zoals dashboardnamen, -beschrijvingen, controleregelselecties, controleregelgroepen, controlestationfilters en andere weergavevoorkeuren.
Integration API
De Integration API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van ingebouwde en externe integraties in uw account.
U heeft toegang tot details zoals integratienamen, -types, gebruikersrechten en andere velden om verbinding te maken met externe diensten voor alertnotificaties, workflows voor incidentbeheer in uw bestaande setup.
Monitor API
De Monitor API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van controleregels in uw account. U kunt monitoringsetups configureren en de beschikbaarheid en performance van uw websites, webservices en API’s op regelmatige basis volgen.
U heeft toegang tot monitoringdata zoals controleregelnaam, -type, -status, controle-interval, controlestations en andere velden.
Raadpleeg Monitor API voor meer informatie.
MonitorCheck API
De MonitorCheck API biedt methoden voor het ophalen van gedetailleerde monitoringresultaten voor elke individuele controle. U heeft toegang tot onbewerkte controleresultaten en performancestatistieken om monitoringtrends te analyseren en problemen op te lossen voor hoofdoorzaakanalyse.
U heeft toegang tot details zoals controletijdstempels, responstijden, foutcodes, foutcondities en andere performancedata.
Raadpleeg MonitorCheck API voor meer informatie.
Monitor Group API
De Monitor Group API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van controleregelgroepen.
U heeft toegang tot details zoals de namen van controleregelgroepen, status, creditverbruik per controleregeltype, de controleregels in de groep en andere velden. Hiermee kunt u controleregels organiseren en bulkbewerkingen uitvoeren zoals het starten, stoppen of configureren van meerdere controleregels tegelijk.
Raadpleeg voor meer informatie Monitor Group API.
Operator API
De Operator API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van operators in uw Uptrends-account. Een operator vertegenwoordigt een gebruiker in uw Uptrends-account.
U heeft toegang tot operatorgegevens zoals operatornamen, e-mailadressen, telefoonnummers, taalvoorkeuren, geen-dienstperiodes en andere instellingen. Zo kunt u gebruikers eenvoudig beheren, inclusief hun gebruikersrechten, inloggegevens en roostervoorkeuren.
Raadpleeg voor meer informatie Operator API.
Operator Group API
De Operator Group API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van operatorgroepen. U kunt operators in groepen organiseren om hetzelfde gedrag, gebruikersrechten en alertinstellingen in te stellen. Zo kunt u meerdere operators organiseren en bulkbewerkingen uitvoeren, zoals het instellen van geen-dienstperiodes en het configureren van toegangsrechten voor alle leden tegelijk.
Raadpleeg Operator Group API voor meer informatie.
OutgoingPhoneNumber API
De OutgoingPhoneNumber API biedt methoden voor het ophalen en beheren van uitgaande telefoonnummers die worden gebruikt voor telefoonalert-integraties om spraakoproepen en sms-berichten af te leveren voor het monitoren van alerts.
PrivateLocation API
De PrivateLocation API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van persoonlijke locaties waarmee u uw applicaties binnen uw interne netwerk kunt monitoren die niet toegankelijk zijn via openbare controlestations.
U heeft toegang tot details zoals namen van persoonlijke locaties, aantal servers, serverstatus, controlestationlocaties, waarschuwingsinformatie, bijbehorende gebruikersrechten en andere velden.
Raadpleeg Private Location API voor meer informatie.
PublicStatusPage API
De PublicStatusPage API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van publieke statuspagina’s. Dit zijn dashboards die beschikbaar zijn voor het grote publiek om uw klanten op de hoogte te houden van de status van uw website.
U heeft toegang tot details zoals namen van statuspagina’s, beschrijvingen, controleregelselecties, weergaveconfiguraties, sla-status en andere velden.
Register API
Met de Register API kunt u een nieuw API-account aanmaken om toegang te krijgen tot Uptrends API-services. Dit is de eerste stap voordat u andere API-eindpunten gebruikt.
Raadpleeg Authenticatie voor gedetailleerde stappen om een account te registreren en hoe authenticatie werkt.
RUM API
De RUM API biedt methoden voor het ophalen van Real User Monitoring (RUM) statistieken en websiteperformancedata van daadwerkelijke gebruikersinteracties. U heeft toegang tot details zoals paginaweergaven, laadtijden, downloadtijd en andere velden om gegevens over gebruikerservaring en browserperformance te volgen.
ScheduledReport API
De ScheduledReport API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van de levering van monitoringrapporten op geplande basis.
U kunt geautomatiseerde rapporten genereren en deze met regelmatige tussenpozen naar gespecificeerde ontvangers verzenden. U heeft toegang tot details zoals rapportnamen, planningsintervallen, ontvangerslijsten en meer.
SLA API
De SLA API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van Service Level Agreement (SLA) -definities en het ophalen van SLA-performancestatistieken voor uw monitoringsetup.
U heeft toegang tot details zoals SLA-namen, SLA-targets, uptimeverplichtingen en andere statistieken om naleving, beschikbaarheid en performance te garanderen die voldoen aan de bedrijfsvereisten.
Raadpleeg SLA API voor meer informatie..
Statistics API
De Statistics API biedt methoden voor het ophalen van statistische informatie uit uw Uptrends-monitoringdata.
U heeft toegang tot historische en realtime statistische informatie om trends te analyseren, rapporten te genereren en inzicht te krijgen in uw serviceperformance gedurende gespecificeerde tijdsperioden.
U heeft toegang tot details zoals responstijden, uptime- en downtimepercentages, foutpercentages, connectiviteits-, performance- en beschikbaarheidsstatistieken.
Status API
De Status API biedt methoden voor het ophalen van realtime statusinformatie over uw controleregels. U heeft toegang tot de beschikbaarheid en performance van uw gemonitorde resources met details zoals foutniveau, foutbeschrijvingen, controlestationlocaties of -servers en andere velden.
Timezone API
De Timezone API biedt methoden voor het beheren van tijdzone-instellingen die bepalen hoe monitoringdata en tijdstempels worden weergegeven in uw Uptrends-account. Het bepaalt de lokale tijdnotatie die wordt gebruikt voor het rapporteren van resultaten van controleregelchecks, alertnotificaties, geplande rapporten en dashboardweergaven.
U heeft toegang tot details zoals tijdzonebeschrijving, zomertijdstatus en andere velden.
Raadpleeg Timezone API voor meer informatie.
Vault API
De Vault API biedt methoden voor het creëren, bijwerken, verwijderen en beheren van vault-items en -secties en de bijbehorende autorisaties. U kunt veilig inloggegevens en gevoelige informatie beheren, zoals vault-itemtypes, gebruikersnamen, wachtwoorden en andere velden.
Raadpleeg voor meer informatie Vault API.