Uptrends' API versie 4 is een groeiend aantal API calls waarmee u uw monitoringconfiguratie kunt wijzigen. U kunt er deze taken mee uitvoeren:

  • een nieuwe API-accountregistreren voor toegang tot de andere methoden in deze API;
  • een bestaande transactie-controleregel wijzigen;
  • een bestaande multi-step API-controleregel wijzigen;
  • een bestaande controleregel klonen;
  • een bestaande controleregel verwijderen.

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.

Monitor Group API

De Controleregelgroep 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 Monitor Group API documentatie.

Vault API

De Vault API bevat methoden voor het toevoegen, bijwerken en verwijderen van items naar/van 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.

Andere API's

Voor andere bewerkingen kunt u overwegen API versie 3 te gebruiken. Lees meer over kiezen tussen API v3 en API v4.

Toegang tot API v4 met Swagger

U kunt alle API-methodes onderzoeken op onze OpenAPI (Swagger)-specificatiepagina: https://api.uptrends.com/v4/swagger. Op deze pagina worden alle API-methodes 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.

Authenticatie

Elke API-methode vereist authenticatie met een API-account, dus moet u er eerst een creëren. Met de methode /Register kunt u een nieuwe API-account creëren. In dit voorbeeld gebruiken we de Swagger-omgeving voor rechtstreekse toegang tot de API en om de Register-methode aan te roepen. De API-account die we nu gaan creëren zal niet verlopen, dus dit hoeft u maar één keer te doen.

  1. Ga naar de Swagger-pagina, zoek de methode Register POST en vouw deze uit.
  2. Klik op de knop Try it out om een request te creëren.
  3. Vul in het veld description een eenvoudige naam in, bijvoorbeeld 'Mijn API account'. Laat het type-veld leeg.
  4. Klik op de knop Execute.
  5. Uw browser vraagt nu om uw inloggegevens van Uptrends, d.w.z. het e-mailadres en wachtwoord dat u normaal als operator gebruikt voor toegang tot Uptrends.
  6. Nadat u met succes hebt ingelogd, ziet u dat de Response body gebruikersnaam- en wachtwoordwaarden bevat: dit zijn de inloggegevens van uw nieuwe API-account.
  7. Bewaar deze inloggegevens en gebruik ze als authenticatie voor alle andere API calls.
  8. Houd er tot slot rekening mee dat deze API-account is gekoppeld aan uw operator, dus deze zal alleen werken met zijn toegangsrechten.