Status pages

Authentication
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint

GET 
https://bugnotify.com/api/v1/status-pages

Request example 

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

Parameters

Name
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: name for Name. Defaults to: name.
monitor_id
optional integer
Monitor ID.
sort_by
optional string
Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional integer
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint

GET 
https://bugnotify.com/api/v1/status-pages/{id}

Request example 

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

API endpoint

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

Request example 

curl --location --request POST 'https://bugnotify.com/api/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'slug={slug}'

Parameters

Name
Type
Description
_method
required string
Must be set to PUT.
name
required string
Name.
slug
required string
Slug.
sections[index][name]
optional string
Section name.
sections[index][monitor_ids]
optional array
Monitor IDs.
privacy
optional integer
Privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password. Defaults to: 0.
password
optional string
Password. Only works with privacy field set to 2.
domain
optional string
Custom domain.
logo
optional file
Logo.
favicon
optional file
Favicon.
remove_logo
optional boolean
Remove logo.
remove_favicon
optional boolean
Remove favicon.
website_url
optional string
Website URL.
contact_url
optional string
Contact URL.
custom_css
optional string
Custom CSS.
custom_js
optional string
Custom JS.
meta_title
optional string
Meta title.
meta_description
optional string
Meta description.
noindex
optional boolean
Exclude the status page from search engines.
Update

API endpoint

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

Request example 

curl --location --request POST 'https://bugnotify.com/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'

Parameters

Name
Type
Description
name
optional string
Name.
slug
optional string
Slug.
sections[index][name]
optional string
Section name.
sections[index][monitor_ids]
optional array
Monitor IDs.
privacy
optional integer
Privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password.
password
optional string
Password. Only works with privacy field set to 2.
domain
optional string
Custom domain.
logo
optional file
Logo.
favicon
optional file
Favicon.
remove_logo
optional boolean
Remove logo.
remove_favicon
optional boolean
Remove favicon.
website_url
optional string
Website URL.
contact_url
optional string
Contact URL.
custom_css
optional string
Custom CSS.
custom_js
optional string
Custom JS.
meta_title
optional string
Meta title.
meta_description
optional string
Meta description.
noindex
optional boolean
Exclude the status page from search engines.
Delete

API endpoint

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

Request example 

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