Overzicht
Publieke statuspagina’s bieden een overzicht van de uptime en prestaties van uw website. Deze kunnen worden gedeeld met een breder publiek, zoals klanten of belanghebbenden, om realtime beschikbaarheidsinformatie te tonen en de transparantie in uw webdiensten te bevorderen.
Gebruiksvoorbeelden
Gebruik de PublicStatusPage API om:
- Publieke statuspagina’s te beheren — creëer, update en verwijder publieke statuspagina’s.
- Instellingen voor publieke statuspagina’s aan te passen — personaliseer uw pagina door de titel, achtergrondkleur, sorteeropties en meer in te stellen.
- Publieke statuspagina’s in bulk te bekijken — bekijk realtime de status en details van meerdere pagina’s tegelijk voor eenvoudigere analyse, tracking en rapportage.
Vereisten
Voordat u de Publieke statuspagina-API gebruikt, moet u ervoor zorgen dat u beschikt over:
Publieke statuspagina API-velden
De PublicStatusPage API bevat verschillende API-velden:
| Veldnaam | Beschrijving |
|---|---|
PublicDashboardGuid |
De unieke identifier van de publieke statuspagina. |
Name |
De naam van de publieke statuspagina. |
IsPublished |
Geeft true aan als de publieke statuspagina wordt gepubliceerd en beschikbaar is voor het publiek. Anders false. |
PresetPeriodType |
De periode waarvoor de data worden weergegeven. Beschikbare filteropties zijn onder andere:
|
CustomizationInfo |
Bevat verschillende velden voor het aanpassen en personaliseren van uw publieke statuspagina. Raadpleeg voor meer informatie de onderstaande sectie CustomizationInfo.
|
SlaGuid |
De unieke identifier van de SLA. Als de gepubliceerde statuspagina data bevat die gebaseerd zijn op een SLA, wordt de geselecteerde SLA gebruikt. |
MonitorGuids |
De unieke identifier van de controleregels die op de publieke statuspagina worden getoond. |
MonitorGroupGuids |
De unieke identifier van de controleregelgroepen die op de publieke statuspagina worden getoond. |
CustomizationInfo-velden
U kunt
de weergave-instellingen aanpassen van uw publieke statuspagina met de CustomizationInfo-velden:
| CustomizationInfo veldnaam | Beschrijving |
|---|---|
MainColor |
De hexadecimale kleurwaarde die wordt gebruikt voor het thema van uw publieke statuspagina. |
BackgroundColor |
De hexadecimale kleurwaarde die wordt gebruikt als achtergrond voor uw publieke statuspagina. |
TextColor |
De hexadecimale kleurwaarde van de tekst op uw publieke statuspagina. |
SortColumnsNewToOld |
Geeft true aan als de kolommen zijn gesorteerd van nieuw naar oud. Anders, false. |
SortRowsProperty |
Definieert hoe rijen worden gesorteerd. Mogelijke waarden zijn Alphabetical (op controleregelnaam) of ByStatus (op controleregelstatus, met fouten eerst). |
CommentTitle |
De titel die wordt weergegeven op de banner van de publieke statuspagina. |
CommentText |
Het bericht dat op de banner wordt weergegeven om gebruikers te informeren over de huidige status of problemen op de publieke statuspagina. |
AutoRefresh |
Geeft true aan als de publieke statuspagina automatisch wordt vernieuwd en data worden opgehaald. Anders, false. |
Publieke statuspagina API-eindpunten
De Publieke statuspagina API biedt de volgende eindpunten voor het beheer van uw controleregels:
Controleregels beheren
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/PublicStatusPage |
Haal een lijst op van alle publieke statuspagina’s in uw account. |
POST |
/PublicStatusPage |
Creëer een nieuwe publieke statuspagina aan met de opgegeven configuratie. |
GET |
/PublicStatusPage/{publicStatusPageGuid} |
Haal de gespecificeerde publieke statuspagina en zijn configuratie op. |
PATCH |
/PublicStatusPage/{publicStatusPageGuid} |
Werk de geselecteerde velden van de definitie van de publieke statuspagina bij. |
PUT |
/PublicStatusPage/{publicStatusPageGuid} |
Werk alle velden van de definitie van de publieke statuspagina bij. |
DELETE |
/PublicStatusPage/{publicStatusPageGuid} |
Verwijder de gespecificeerde publieke statuspagina uit uw account. |
Raadpleeg de Uptrends Public status page API-documentatie voor gedetailleerde request- en responsformaten en interactieve API-tests.
Problemen oplossen
Deze sectie behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de Publieke statuspagina API.
Veelvoorkomende fouten
Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:
| Statuscode | Beschrijving |
|---|---|
| 200 | OK — request succesvol |
| 204 | No content — de request is succesvol voltooid en er is geen response geretourneerd. Dit geldt voor de requests DELETE, PUT, PATCH en POST. |
| 400 | Bad request — ongeldige requestparameters of ontbrekende verplichte velden. |
| 401 | Unauthorized — ongeldige of ontbrekende authenticatiegegevens. |
| 403 | Forbidden — toestemming geweigerd. |
| 404 | Not Found — de gespecificeerde GUID bestaat niet. |
| 500 | Internal Server Error — er is een serverfout opgetreden. |
Algemene handleiding voor probleemoplossing
Zorg ervoor dat u:
- Altijd uw request data valideert voordat u API-calls verstuurt.
- Voor elke operation de juiste HTTP-methoden gebruikt.
Neem voor verdere ondersteuning contact op met ons Support-team.
Aanvullende artikelen
Raadpleeg de volgende artikelen voor meer informatie:
- Uptrends Public status page API-documentatie — een interactieve API-documentatie met gedetailleerde eindpuntspecificaties.
- API changelog — voor de laatste API-updates en meldingen over verouderde API’s.