Uptrends API versie 4 is een groeiende set API-eindpunten en -methoden die u helpen informatie uit uw monitoringconfiguratie te halen. Zorg ervoor dat u al een API-account heeft geregistreerd om API-calls te maken.
Toegang tot API v4 met Swagger
Alle Uptrends API methoden zijn beschikbaar op de Uptrends OpenAPI (Swagger)-pagina . Op deze pagina worden alle API-methoden gedetailleerd beschreven en u kunt er elke methode afzonderlijk uitvoeren.
U kunt onze Swagger-specificatie en Swagger Codegen gebruiken om clientcode te genereren en de Uptrends API in uw scripts of applicaties te integreren. Ga naar Swagger.io voor meer informatie over Swagger en Swagger-tools.
Eindpunten
De volgende API-eindpunten worden momenteel ondersteund:
Register API
De eerste stap die u moet nemen voordat u de andere methoden in deze API gebruikt, is het registreren van een API-account. Zie het artikel Authenticatie voor gedetailleerde stappen om een account te registreren en hoe authenticatie werkt.
Monitor API
De Monitor API bevat methoden voor het beheren van controleregeldefinities. Zie voor meer informatie Monitor API-documentatie .
MonitorCheck API
De MonitorCheck API bevat methoden om toegang te krijgen tot onbewerkte controleregeldata voor elke afzonderlijke controle. Zie voor meer informatie MonitorCheck API-documentatie .
Monitor Group API
De MonitorGroup API bevat methoden voor het toevoegen, bijwerken en verwijderen van controleregelgroepen en bewerkingen binnen controleregelgroepen (zoals het starten en stoppen van alle controleregels). Zie Monitor Group API-documentatie voor meer informatie.
Operator API
De Operator API bevat methoden voor het toevoegen, bijwerken en verwijderen van operators. Een operator vertegenwoordigt een gebruiker in een Uptrends-account. U kunt deze API gebruiken om gebruikersbeheer in uw account te automatiseren. Naast het beheren van deze gebruikerslogins en instellingen voor elke individuele operator (inclusief taal- en communicatie-instellingen), kunt u met deze API ook de geen-dienstperiodes voor elke operator beheren. Zie Operator API-documentatie voor meer informatie.
Operator Group API
De OperatorGroup API bevat methoden voor het toevoegen, bijwerken en verwijderen van operatorgroepen. U kunt operators in groepen indelen om hetzelfde gedrag, dezelfde toegangsrechten en dezelfde alertinstellingen in te stellen. Met de OperatorGroup API kunt u ook geen-dienstperiodes creëren voor alle operators in een groep. Zie Operator Group API-documentatie voor meer informatie.
Alert API
De Alert API bevat methoden voor het beheren van alerts. Zie Alert API voor meer informatie.
Alert Definitions API
De Alert Definition API bevat methoden voor het beheren van alertdefinities. Zie Alert Definition API voor meer informatie.
Vault API
De Vault API bevat methoden voor het toevoegen aan, bijwerken van en verwijderen van items uit uw vault, vault-secties en bijbehorende autorisaties. Zie voor meer informatie de Vault API-documentatie en de Vault .
Checkpoint API
De Checkpoint API bevat methoden waarmee u informatie kunt ophalen over de controlestationlocaties of -servers die de feitelijke monitoring uitvoeren. De Checkpoint-serverinformatie bevat IPv4- and IPv6-adressen die u kunt gebruiken voor whitelisting in uw firewall. Ga voor meer informatie naar de Swagger-documentatie voor de Checkpoint endpoints .