Met de Uptrends API kunt u op een geautomatiseerde manier met uw Uptrends-account werken: u kunt scripts bouwen die uw monitoringconfiguratie wijzigen en u hebt toegang tot uptime- en performancedata om uw eigen rekenwerk te doen.
Bezoek de API changelog voor de meest recente informatie over wijzigingen en nieuwe functies in de API.
API-versies
We hebben momenteel twee API-versies:
- Versie 4 is de aanbevolen versie voor het gebruik van de Uptrends API. Wanneer u met de API begint te werken, is dit de versie die u moet hebben. Versie 4 biedt veel meer functionaliteit dan versie 3.
- Versie 3 is een oudere versie en heeft veel minder opties dan versie 4 van de API. Gebruik deze alleen als u al versie 3-API’s hebt geïmplementeerd en erop vertrouwt.
Versie 3 wordt nog steeds ondersteund, maar heeft niet de voorkeur en zal in de loop van de tijd worden beëindigd. Versie 3 en 4 zullen nog enige tijd naast elkaar bestaan. Het einde van de levensduur van versie 3 wordt ruim van tevoren aangekondigd, zodat er voldoende tijd is om een overstap naar versie 4 voor te bereiden.
Beide versies zijn REST API’s die vereisen dat u inloggegevens verstrekt met een Basic Authentication HTTP header. De inloggegevens die voor de authenticatie worden gebruikt zijn verschillend voor de versies, zie de bijbehorende documentatie voor meer informatie.
Meer informatie over het gebruik van de API is te vinden in de Knowledge Base-artikelen en de API-specificatieomgeving, zoals hieronder vermeld.
Algemene API-info (versie 3 en 4)
Toegang tot de Uptrends API met cURL
Toegang tot de Uptrends API met Powershell
IP-adressen aan de whitelist toevoegen
Controlestationregio’s specificeren
API versie 4
Authenticatie en een API-account maken
OpenAPI-specificatie (Swagger-omgeving)
API versie 3
Gerelateerde artikelen
-
Alert Definition APIMet de Alert Definition API kunt u instellingen voor een specifieke alertdefinitie beheren. Een alertdefinitie wordt gebruikt om te definiëren hoe en naar wie een alert wordt verstuurd. U kunt bijvoorbeeld configureren dat een alert moet worden gegenereerd wanneer er meer dan 5 minuten een fout optreedt en kiezen welke gebruikers per e-mail en SMS op de hoogte moeten worden gesteld. De Alert Definition API ondersteunt momenteel alleen het in- en uitschakelen van een alertdefinitie met de instelling Active.
-
API changelogBekijk de wijzigingen, updates en verbeteringen voor de Uptrends API
-
API versie 4Met onze 4e versie van de Uptrends API kunt u Multi-step API- en transactie-controleregels beheren en wijzigen. Onze nieuwste versie van de API zal blijven groeien.
-
Authenticatie (versie 4)Hoe u uw API-account registreert en hoe authenticatie werkt
-
Controlestationregio's specificerenAccounts die alleen complete controlestationregio’s kunnen selecteren om hun controleregels op te draaien (in tegenstelling tot een onbeperkt aanbod van individuele checkpoints), moeten een bijzondere waarde specificeren wanneer ze controleregels aanmaken of bijwerken via de API. In het Checkpoints-veld (welke bestaat uit een lijst van controlestation ID’s, gescheiden met een komma) specificeert u een van deze regels: Alleen Europa: `{"Regions":[1004]}` Alleen Noord-Amerika: `{"Regions":[1005]}` Allebei: laat het veld leeg, of specificeer `{"Regions":[1004,1005]}`
-
De juiste API-versie kiezenWelke API werkt het beste voor uw behoeften: versie 3, versie 4 of beide?
-
Monitor APIDe eindpunten die deel uitmaken van de Monitor API helpen u bij het beheren van uw controleregelinstellingen in Uptrends. Controleregels zijn de dingen die u definieert in Uptrends om te beschrijven wat moet worden gemonitord. Doorgaans controleert een controleregel een enkele webpagina of een reeks API calls of een klikpad van een eindgebruiker op een website. De Monitor API heeft verschillende eindpunten waarmee u controleregeldefinities kunt creëren, wijzigen, klonen of verwijderen.
-
Monitor API veldenIn dit artikel worden de API-velden beschreven die relevant zijn voor het werken met de Monitor API. De definitie van een Monitor-object bevat veel velden. Sommige velden zijn van toepassing op alle controleregels (bijvoorbeeld MonitorGuid, Name, CheckInterval enzovoort). Echter, aangezien verschillende typen controleregels verschillende instellingen vereisen, zijn veel velden alleen relevant voor specifieke controleregeltypen. Algemene controleregelvelden Veldnaam Beschrijving MonitorGuid De unieke ID van de controleregel.
-
MonitorCheck APIMonitor check data kunnen worden opgehaald met behulp van de MonitorCheck API-eindpunten die deel uitmaken van API v4. Monitor checks zijn de individuele metingen die we voor elke controleregel verzamelen, dus de MonitorCheck API geeft toegang tot die ruwe data. Nadat de data zijn opgehaald, kunt u die opslaan in een database voor offline analyse, audit of back-updoeleinden. De volgende drie eindpunten zijn beschikbaar: MonitorCheck endpoint Gebruik /MonitorCheck Retourneert alle Monitor check data in de account.
-
MonitorGroup APIDeze pagina beschrijft de beschikbare API-methoden voor het manipuleren van controleregelgroepen.
-
Onderhoudsperioden in de APIEr is een specifieke set API-methoden voor het bewerken van onderhoudsperioden voor een controleregel of voor alle controleregels in een controleregelgroep. Objectbeschrijving onderhoudsperiode Het volgende MaintenancePeriod object wordt gebruikt in de hieronder beschreven API-methoden: NaamBeschrijvingDatatypeIdDe unieke identifier voor deze onderhoudsperiodeIntegerScheduleModeOneTime, Daily, Weekly of MonthlyEnumStartDateTimeEen begindatum en -tijd (alleen van toepassing op een eenmalige geplande periode)DateTimeEndDateTimeDe einddatum en -tijd van een eenmalige geplande onderhoudsperiodeDateTimeStartTimeDe begintijd (“HH:mm”, in 24-uursnotatie) voor een terugkerende (Daily, Weekly of Monthly) onderhoudsperiodeString (“HH:mm”)EndTimeDe eindtijd (“HH:mm”, in 24-uursnotatie) voor een terugkerende (Daily, Weekly of Monthly) onderhoudsperiodeString (“HH:mm”)WeekDayDe dag van de week voor een wekelijkse onderhoudsperiode
-
Operator APIDe beschikbare API-methodes voor het manipuleren van operators.
-
Operator Group APIDe beschikbare API-methodes voor het manipuleren van operatorgroepen.
-
Toegang tot de Uptrends API met cURLHet volgende voorbeeld benadert de Uptrends API en haalt de lijst met de locaties van Uptrends' controlestations op. Dit cURL statement bevat de Uptrends inloggegevens en een header die verzoekt de respons terug te sturen in JSON-formaat. curl https://api.uptrends.com/v3/checkpointservers -k --user james@galacticresorts.com:1234xxx --header "Accept: application/json" Tip: Heeft u geen cURL? Download deze dan van: https://curl.haxx.se/download.html.
-
Toegang tot de Uptrends API met PowershellHet volgende voorbeeld geeft toegang tot de Uptrends API en haalt de lijst van Uptrends' controlestation locaties op. # Specify your Uptrends login info here $user = "james@galacticresorts.com" $pass= "1234xxx" # URI to the API method you want to execute $uri = "https://api.uptrends.com/v3/checkpointservers" # Compile the login info into credentials containing basic authentication $passwordValue = ConvertTo-SecureString $pass -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential ($user, $passwordValue) # Execute the request $result = Invoke-RestMethod -Uri $uri -Method Get -Credential $cred -Headers @{ Accept = "application/json" }
-
Uptrends API v3Gebruik versie 3 van de Uptrends API voor het wijzigen van controleregels (behalve controleregels Multi-step API en Transactie), het ontvangen van status updates en het ophalen van controlestationdata.
-
Vault APIDe Vault wordt gebruikt voor het opslaan van herbruikbare data, vaak gevoelige data zoals certificaten, public keys en combinaties van gebruikersnaam en wachtwoord. Elke vermelding in de Vault wordt een vault-item genoemd en vault-items zijn georganiseerd in Vault-secties. Het organiseren van items in verschillende secties is ook nuttig om de toegang te beperken tot bepaalde operators en groepen. In dit artikel wordt beschreven welke API-methoden beschikbaar zijn voor het beheer van vault-items, vault-secties en vault-sectie-authorisaties.