API-referentie voor monitoringintegraties

Je kunt via de REST API programmatisch integraties met externe monitoringdiensten aanmaken.

Een integratie aanmaken

Endpoint:

POST /v3/integrations

Body-parameters

VeldTypeBeschrijving
pageIdstringID van de statuspagina
integrationTypestringType integratie, bijvoorbeeld PINGDOM, NEWRELIC
componentsstring[]ID's van de te koppelen componenten

Voorbeeldverzoek

{
"pageId": "page123",
"integrationType": "PINGDOM",
"components": ["component1", "component2"]
}

Voorbeeldrespons

{
"integration": {
"id": "int_abc",
"monitoringTool": "PINGDOM"
},
"message": "Integration created successfully."
}

Dit endpoint accepteert elke monitoringtool die in onze MonitoringTool-enum staat.

Een integratie bijwerken

Endpoint:

PUT /v3/integrations/:integration_id

Stuur een van de velden van het aanmaak-endpoint mee, of geef nieuwe sjabloondata op om het aanmaken en oplossen van incidenten aan te passen.

Voorbeeldverzoek

{
"label": "Pingdom Primary",
"createTemplate": { "name": "New incident" },
"resolveTemplate": { "name": "Incident resolved" }
}

Voorbeeldrespons

{
"integration": {
"id": "int_abc",
"label": "Pingdom Primary"
}
}

Een integratie verwijderen

Endpoint:

DELETE /v3/integrations/:integration_id

Voorbeeldrespons

{}