Incidenten

Opmerkingen
Expert-niveau
De API-sleutel moet als Bearer-token in de Authorization-header van het verzoek worden meegestuurd. Haal uw API-sleutel op.
Lijst

API-endpoint:

GET 
https://upsio.nl/api/v1/incidents

Voorbeeldverzoek: 

curl --location --request GET 'https://upsio.nl/api/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Beschrijving
search
optioneel string
De zoekopdracht.
search_by
optioneel string
Zoeken op. Mogelijke waarden zijn: monitor voor Monitor, cause voor Oorzaak. Standaardwaarde: url.
monitor_id
optioneel string
Monitor-ID.
status
optioneel string
Status. Mogelijke waarden zijn: unresolved voor Niet opgelost, acknowledged voor Bevestigd, resolved voor Opgelost.
sort_by
optioneel string
Sorteren op. Mogelijke waarden zijn: started_at voor Startdatum, ended_at voor Einddatum. Standaardwaarde: ended_at.
sort
optioneel string
Sorteren. Mogelijke waarden zijn: desc voor Aflopend, asc voor Oplopend. Standaardwaarde: desc.
per_page
optioneel integer
Resultaten per pagina. Mogelijke waarden zijn: 10, 25, 50, 100. Standaardwaarde: 10.
Tonen

API-endpoint:

GET 
https://upsio.nl/api/v1/incidents/{id}

Voorbeeldverzoek: 

curl --location --request GET 'https://upsio.nl/api/v1/incidents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Opslaan

API-endpoint:

POST 
https://upsio.nl/api/v1/incidents

Voorbeeldverzoek: 

curl --location --request POST 'https://upsio.nl/api/v1/incidents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'monitor_id={monitor_id}' \
--data-urlencode 'started_at={started_at}'
Parameter
Type
Beschrijving
monitor_id
verplicht integer
Monitor-ID.
started_at
verplicht string
Gestart op datum in het formaat Y-m-dTH:i:s.
acknowledged_at
optioneel string
Bevestigd op datum in het formaat Y-m-dTH:i:s.
ended_at
optioneel string
Beeindigd op datum in het formaat Y-m-dTH:i:s.
cause
optioneel string
Oorzaak.
comment
optioneel string
Opmerking.
Bijwerken

API-endpoint:

PUT PATCH 
https://upsio.nl/api/v1/incidents/{id}

Voorbeeldverzoek: 

curl --location --request PUT 'https://upsio.nl/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Beschrijving
acknowledged_at
optioneel string
Bevestigd op datum in het formaat Y-m-dTH:i:s.
ended_at
optioneel string
Beeindigd op datum in het formaat Y-m-dTH:i:s.
cause
optioneel string
Oorzaak.
comment
optioneel string
Opmerking.
Verwijderen

API-endpoint:

DELETE 
https://upsio.nl/api/v1/incidents/{id}

Voorbeeldverzoek: 

curl --location --request DELETE 'https://upsio.nl/api/v1/incidents/{id}' \
--header 'Authorization: Bearer {api_key}'