Deze pagina beschrijft de beschikbare API-methodes voor het manipuleren van controleregelgroepen. Raadpleeg Uptrends Controleregelgroep API voor meer informatie.
Beschrijving van het MonitorGroup-object
Het volgende MonitorGroup-object wordt gebruikt in de MonitorGroupAPI-eindpunten:
| Naam | Beschrijving | Datatype |
|---|---|---|
MonitorGroupGuid |
De unieke identificatie voor de controleregelgroep. | Tekenreeks |
Description |
De naam van de controleregelgroep. | Tekenreeks |
IsAll |
Geeft aan of de controleregelgroep de standaard Alle controleregels-groep is.
|
Booleaans |
IsQuotaUnlimited |
Geeft aan of het aantal credits voor de controleregelgroep onbeperkt is of niet. | Booleaans |
UsedBasicMonitorQuota |
Retourneert het aantal credits dat is gebruikt voor Uptimecontroleregels.
|
Geheel getal |
UsedBrowserMonitorQuota |
Retourneert het aantal credits dat is gebruikt voor Browsercontroleregels (Full-Page Check).
|
Geheel getal |
UsedTransactionMonitorQuota |
Retourneert het aantal credits dat is gebruikt voor Transactiecontroleregels.
|
Geheel getal |
UsedApiMonitorQuota |
Retourneert het aantal credits dat is gebruikt voor Multi-step API (MSA) en Postman-controleregels.
|
Geheel getal |
UsedClassicQuota |
Retourneert het aantal credits dat wordt gebruikt door bestaande accounts die één creditprijstarief gebruiken. | Geheel getal |
De groep Alle controleregels
De groep Alle controleregels is een controleregel- of systeemgroep die standaard al uw controleregels bevat. Gebruik de Guid van deze groep om bewerkingen te beheren die van invloed zijn op alle controleregels, zoals het starten of stoppen van alle controleregels of alerts. Merk op dat u het lidmaatschap van deze groep niet kunt wijzigen.
Eindpunten voor controleregelgroepbeheer
De volgende API-eindpunten zijn beschikbaar voor het maken, wijzigen en verwijderen van controleregelgroepen, evenals de controleregels binnen die groepen.
| Requesttype | 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:
| Requesttype | 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 groep |