Incidenty

Poznámky
Expertní úroveň
API klíč by měl být odeslán jako Bearer token v Authorization hlavičce požadavku. Získat API klíč.
Seznam

API endpoint:

GET 
https://siteuptimes.com/api/v1/incidents

Příklad požadavku: 

curl --location --request GET 'https://siteuptimes.com/api/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
nepovinné string
Vyhledávací dotaz.
search_by
nepovinné string
Hledat podle. Možné hodnoty jsou: monitor pro Monitor, cause pro Příčina. Výchozí hodnota: url.
monitor_id
nepovinné string
ID monitoru.
status
nepovinné string
Stav. Možné hodnoty jsou: unresolved pro Nevyřešeno, acknowledged pro Potvrzeno, resolved pro Vyřešeno.
sort_by
nepovinné string
Seřadit podle. Možné hodnoty jsou: started_at pro Datum začátku, ended_at pro Datum ukončení. Výchozí hodnota: ended_at.
sort
nepovinné string
Řadit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.
per_page
nepovinné integer
Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 25.
Zobrazit

API endpoint:

GET 
https://siteuptimes.com/api/v1/incidents/{id}

Příklad požadavku: 

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

API endpoint:

PUT PATCH 
https://siteuptimes.com/api/v1/incidents/{id}

Příklad požadavku: 

curl --location --request PUT 'https://siteuptimes.com/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parametr
Typ
Popis
comment
nepovinné string
Komentář.
acknowledged_at
nepovinné boolean
Potvrdit.
Smazat

API endpoint:

DELETE 
https://siteuptimes.com/api/v1/incidents/{id}

Příklad požadavku: 

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