馃憠 Comen莽a gratis avui: supervisa la teva web, consulta estad铆stiques i rep alertes immediates.

P脿gines d'estat

Notes
Nivell expert
La clau API s'ha d'enviar com un token Bearer a la cap莽alera Authorization de la petici贸. Obt茅n la teva clau API.
Llista

Extrem de API:

GET 
https://pingweb.cat/api/v1/status-pages

Exemple de petici贸: 

curl --location --request GET 'https://pingweb.cat/api/v1/status-pages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Par脿metre
Tipus
Descripci贸
search
opcional string
La consulta de cerca.
search_by
opcional string
Cerca per. Els valors possibles s贸n: name per Nom. Per defecte: name.
monitor_id
opcional integer
ID del monitor.
sort_by
opcional string
Ordena per. Els valors possibles s贸n: id per Data de creaci贸, name per Nom. Per defecte: id.
sort
opcional string
Ordena. Els valors possibles s贸n: desc per Descendent, asc per Ascendent. Per defecte: desc.
per_page
opcional integer
Resultats per p脿gina. Els valors possibles s贸n: 10, 25, 50, 100. Per defecte: 10.
Mostra

Extrem de API:

GET 
https://pingweb.cat/api/v1/status-pages/{id}

Exemple de petici贸: 

curl --location --request GET 'https://pingweb.cat/api/v1/status-pages/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Emmagatzema

Extrem de API:

POST 
https://pingweb.cat/api/v1/status-pages

Exemple de petici贸: 

curl --location --request POST 'https://pingweb.cat/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}'
Par脿metre
Tipus
Descripci贸
name
obligatori string
Nom.
slug
obligatori string
Slug.
monitor_ids[]
opcional array
IDs de monitors
privacy
opcional integer
Privacitat. Els valors possibles s贸n: 0 per P煤blic, 1 per Privat, 2 per Contrasenya. Per defecte: 0.
password
opcional string
Contrasenya. Nom茅s funciona amb el camp privacy establert a 2.
domain
opcional string
Domini personalitzat.
logo
opcional file
Logo.
favicon
opcional file
Favicon.
remove_logo
opcional boolean
Elimina el logotip.
remove_favicon
opcional boolean
Elimina el favicon.
website_url
opcional string
URL del lloc web.
contact_url
opcional string
URL de contacte.
custom_css
opcional string
Custom CSS.
custom_js
opcional string
JS personalitzat.
meta_title
opcional string
T铆tol meta.
meta_description
opcional string
Descripci贸 meta.
noindex
opcional boolean
Exclou la p脿gina d'estat dels motors de cerca.
Actualitza

Extrem de API:

POST 
https://pingweb.cat/api/v1/status-pages/{id}

Exemple de petici贸: 

curl --location --request POST 'https://pingweb.cat/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
Par脿metre
Tipus
Descripci贸
_method
obligatori string
S'ha d'establir a PUT.
name
opcional string
Nom.
slug
opcional string
Slug.
monitor_ids[]
opcional array
IDs de monitors
privacy
opcional integer
Privacitat. Els valors possibles s贸n: 0 per P煤blic, 1 per Privat, 2 per Contrasenya.
password
opcional string
Contrasenya. Nom茅s funciona amb el camp privacy establert a 2.
domain
opcional string
Domini personalitzat.
logo
opcional file
Logo.
favicon
opcional file
Favicon.
remove_logo
opcional boolean
Elimina el logotip.
remove_favicon
opcional boolean
Elimina el favicon.
website_url
opcional string
URL del lloc web.
contact_url
opcional string
URL de contacte.
custom_css
opcional string
Custom CSS.
custom_js
opcional string
JS personalitzat.
meta_title
opcional string
T铆tol meta.
meta_description
opcional string
Descripci贸 meta.
noindex
opcional boolean
Exclou la p脿gina d'estat dels motors de cerca.
Elimina

Extrem de API:

DELETE 
https://pingweb.cat/api/v1/status-pages/{id}

Exemple de petici贸: 

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