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

MonitorGroup API

Op deze pagina worden de beschikbare API-methoden voor het manipuleren van controleregelgroepen beschreven.

MonitorGroupobjectbeschrijving

Het volgende MonitorGroup object wordt gebruikt in de API-methoden die hieronder worden beschreven:

Naam Beschrijving
MonitorGroupGuid De unieke ID voor deze controleregelgroep.
Description Een string die een beschrijvende naam bevat.
IsAll Geeft aan of deze groep de systeemgroep “Alle controleregels” is. True of False.

De groep Alle controleregels

De groep Alle controleregels (de beschrijving van deze groep kan een andere naam hebben, afhankelijk van de taal in uw account) is een systeemgroep die altijd alle controleregels bevat. U kunt in deze groep geen wijzigingen aanbrengen. Het gebruik van de GUID van deze groep is handig voor bewerkingen die een hele groep beïnvloeden, zoals het starten/stoppen van alle controleregels of alerts.

Controleregelgroepmanagement eindpunten

De volgende API-eindpunten zijn beschikbaar voor het maken, wijzigen en verwijderen van controleregelgroepen en voor het toevoegen/verwijderen van leden in die groepen.

Request type Eindpunt Gebruik
GET /MonitorGroup Verkrijgt alle controleregelgroepen
POST /MonitorGroup Creëert een nieuwe controleregelgroep
GET /MonitorGroup/{monitorGroupGuid} Verkrijgt de details van een controleregelgroep
PUT /MonitorGroup/{monitorGroupGuid} Werkt een bestaande controleregelgroep bij
DELETE /MonitorGroup/{monitorGroupGuid} Verwijdert een controleregelgroep
GET /MonitorGroup/{monitorGroupGuid}/Members Verkrijgt een lijst met alle controleregels die lid zijn van een controleregelgroep
POST /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Voegt de gespecificeerde controleregel toe aan de controleregelgroep
DELETE /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Verwijdert de gespecificeerde controleregel uit de controleregelgroep

Extra controleregelgroepbewerkingen

De volgende API-eindpunten zijn beschikbaar voor het uitvoeren van bewerkingen op alle controleregels in een groep:

Request type Eindpunt Gebruik
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitors Stopt alle controleregels in de gespecificeerde controleregelgroep
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitors Start alle controleregels in de gespecificeerde controleregelgroep
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts Stopt alerting voor alle controleregels in de gespecificeerde controleregelgroep
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts Start alerting voor alle controleregels in de gespecificeerde controleregelgroep
POST /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers Voegt de verstrekte onderhoudsperiode toe aan alle controleregels in de gespecificeerde controleregelgroep
Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.