1. Support
  2. Knowledge Base
  3. Uptrends' API
  4. API versie 4

API versie 4

We vernieuwen onze gebruikersinterface. Sommige informatie is nog niet aangepast. Lees meer.

Uptrends' API versie 4 is een groeiende set API-eindpunten en -methoden waarmee u informatie uit uw monitoringconfiguratie kunt halen en wijzigen.

Om API-aanroepen te kunnen doen moet u een API-account aanmaken. Zie Registreer API voor de stappen.

Toegang tot API v4 met Swagger

U kunt alle API-methoden onderzoeken op onze Engelstalige OpenAPI (Swagger) specificatiepagina. Op deze pagina worden alle API-methoden gedetailleerd beschreven en u kunt er elke methode afzonderlijk uitvoeren.

Bovendien kunt u onze Swagger-specificatie samen met Swagger Codegen gebruiken om klantspecifieke code te genereren waarmee u de Uptrends API kunt integreren in uw eigen scripts of applicaties. Meer informatie over Swagger en Swagger-tools vindt u op Swagger.io.

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

Een set API-methoden voor het beheren van controleregeldefinities. Alles wat u nodig hebt om uw controleregelbeheer te automatiseren, wordt beschreven in de Monitor API-documentatie.

MonitorCheck API

Een set API-methoden om toegang te krijgen tot onbewerkte controleregeldata voor elke individuele controle. Lees voor meer informatie de MonitorCheck API-documentatie.

MonitorGroup API

De MonitorGroup API bevat methoden voor het toevoegen, bijwerken en verwijderen van controleregelgroepen en voor extra bewerkingen van de controleregels in die groepen, zoals het starten en stoppen van alle controleregels. Lees voor meer informatie de MonitorGroup API-documentatie.

Operator API

De Operator API is een reeks 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 (waaronder taal- en communicatie-instellingen), kunt u met deze API ook de geen-dienstperiodes voor elke operator beheren. Meer informatie vindt u in de Operator API-documentatie.

OperatorGroup API

De OperatorGroup API bevat methoden voor het toevoegen, bijwerken en verwijderen van operatorgroepen. U kunt operators in groepen organiseren, waardoor u voor die operators hetzelfde gedrag qua toegangsrechten en alertinstellingen kunt configureren. Met de OperatorGroup API kunt u ook Dienstroosters creëren voor alle operators in een groep. Meer informatie vindt u in de OperatorGroup API-documentatie.

Alert Definitions API

API-methoden voor het beheren van alertdefinities. Meer informatie vindt u in de Alert Definition API-documentatie.

Vault API

De Vault API bevat methoden voor het toevoegen, bijwerken en verwijderen van items aan/uit uw vault en voor het onderhouden van de vault-sectie en bijbehorende autorisaties. Lees voor meer informatie de Vault API-documentatie en het knowledge base-artikel over de vault.

Checkpoint API

Met de Checkpoint API kunt u informatie opvragen over de controlestationlocaties/-servers die de feitelijke monitoring uitvoeren. De informatie van de controlestationserver bevat IPv4- and IPv6-adressen die u kunt gebruiken voor whitelisting in uw firewall. Lees voor meer informatie de Swagger-documentatie voor de Checkpoint endpoints.

Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.