狀態頁面

備註
進階等級
API 金鑰應以 Bearer Token 格式加入請求的 Authorization 標頭中。 取得您的 API 金鑰.
列表

API 端點:

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

請求範例: 

curl --location --request GET 'https://newsbobo.com/api/v1/status-pages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
參數
類型
描述
search
選填 string
搜尋查詢字串。
search_by
選填 string
搜尋依據. 可能的值有：name 用於 姓名。 預設為：name。
monitor_id
選填 integer
監控 ID.
sort_by
選填 string
排序方式. 可能的值有：id 用於 建立日期, name 用於 姓名。 預設為：id。
sort
選填 string
排序. 可能的值有：desc 用於 遞減, asc 用於 遞增。 預設為：desc。
per_page
選填 integer
每頁顯示筆數. 可能的值有：10, 25, 50, 100。 預設為：10。
顯示

API 端點:

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

請求範例: 

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

API 端點:

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

請求範例: 

curl --location --request POST 'https://newsbobo.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}'
參數
類型
描述
name
必填 string
姓名.
slug
必填 string
網址代稱.
monitor_ids[]
選填 array
監控 ID
privacy
選填 integer
隱私. 可能的值有：0 用於 公開, 1 用於 私人, 2 用於 密碼。 預設為：0。
password
選填 string
密碼. 僅當 privacy 欄位設為 2 時可用。
domain
選填 string
自訂網域.
logo
選填 file
標誌.
favicon
選填 file
網站小圖示.
remove_logo
選填 boolean
移除 Logo.
remove_favicon
選填 boolean
移除網站圖示.
website_url
選填 string
網站網址.
contact_url
選填 string
聯絡網址.
custom_css
選填 string
自訂 CSS.
custom_js
選填 string
自訂 JavaScript.
meta_title
選填 string
Meta 標題.
meta_description
選填 string
Meta 描述.
noindex
選填 boolean
將狀態頁面排除於搜尋引擎索引。
更新

API 端點:

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

請求範例: 

curl --location --request POST 'https://newsbobo.com/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
參數
類型
描述
_method
必填 string
必須設定為 PUT。
name
選填 string
姓名.
slug
選填 string
網址代稱.
monitor_ids[]
選填 array
監控 ID
privacy
選填 integer
隱私. 可能的值有：0 用於 公開, 1 用於 私人, 2 用於 密碼。
password
選填 string
密碼. 僅當 privacy 欄位設為 2 時可用。
domain
選填 string
自訂網域.
logo
選填 file
標誌.
favicon
選填 file
網站小圖示.
remove_logo
選填 boolean
移除 Logo.
remove_favicon
選填 boolean
移除網站圖示.
website_url
選填 string
網站網址.
contact_url
選填 string
聯絡網址.
custom_css
選填 string
自訂 CSS.
custom_js
選填 string
自訂 JavaScript.
meta_title
選填 string
Meta 標題.
meta_description
選填 string
Meta 描述.
noindex
選填 boolean
將狀態頁面排除於搜尋引擎索引。
刪除

API 端點:

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

請求範例: 

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