Stavové stránky

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/status-pages

Příklad požadavku: 

curl --location --request GET 'https://siteuptimes.com/api/v1/status-pages' \
--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: name pro Jméno. Výchozí hodnota: name.
monitor_id
nepovinné integer
ID monitoru.
sort_by
nepovinné string
Seřadit podle. Možné hodnoty jsou: id pro Datum vytvoření, name pro Jméno. Výchozí hodnota: id.
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/status-pages/{id}

Příklad požadavku: 

curl --location --request GET 'https://siteuptimes.com/api/v1/status-pages/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Uložit

API endpoint:

POST 
https://siteuptimes.com/api/v1/status-pages

Příklad požadavku: 

curl --location --request POST 'https://siteuptimes.com/api/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={url}' \
--data-urlencode 'slug={id}'
Parametr
Typ
Popis
name
povinné string
Jméno.
slug
povinné string
URL identifikátor.
monitor_ids[]
nepovinné array
ID monitorů
privacy
nepovinné integer
Ochrana údajů. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo. Výchozí hodnota: 0.
password
nepovinné string
Heslo. Funguje pouze s polem privacy nastaveným na 2.
domain
nepovinné string
Vlastní doména.
logo
nepovinné file
Logo.
favicon
nepovinné file
Favicon.
remove_logo
nepovinné boolean
Odebrat logo.
remove_favicon
nepovinné boolean
Odebrat favicon.
website_url
nepovinné string
URL webu.
contact_url
nepovinné string
Kontaktní URL.
custom_css
nepovinné string
Vlastní CSS.
custom_js
nepovinné string
Vlastní JS.
meta_title
nepovinné string
Meta titulek.
meta_description
nepovinné string
Meta popis.
noindex
nepovinné boolean
Vyloučit stavovou stránku z vyhledávačů.
Aktualizovat

API endpoint:

POST 
https://siteuptimes.com/api/v1/status-pages/{id}

Příklad požadavku: 

curl --location --request POST 'https://siteuptimes.com/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
Parametr
Typ
Popis
_method
povinné string
Musí být nastaveno na PUT.
name
nepovinné string
Jméno.
slug
nepovinné string
URL identifikátor.
monitor_ids[]
nepovinné array
ID monitorů
privacy
nepovinné integer
Ochrana údajů. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo.
password
nepovinné string
Heslo. Funguje pouze s polem privacy nastaveným na 2.
domain
nepovinné string
Vlastní doména.
logo
nepovinné file
Logo.
favicon
nepovinné file
Favicon.
remove_logo
nepovinné boolean
Odebrat logo.
remove_favicon
nepovinné boolean
Odebrat favicon.
website_url
nepovinné string
URL webu.
contact_url
nepovinné string
Kontaktní URL.
custom_css
nepovinné string
Vlastní CSS.
custom_js
nepovinné string
Vlastní JS.
meta_title
nepovinné string
Meta titulek.
meta_description
nepovinné string
Meta popis.
noindex
nepovinné boolean
Vyloučit stavovou stránku z vyhledávačů.
Smazat

API endpoint:

DELETE 
https://siteuptimes.com/api/v1/status-pages/{id}

Příklad požadavku: 

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