共用方式為


Instatus (獨立發行者) (預覽版)

取得可抵禦停機且快速載入的狀態頁面。 您的狀態頁面是靜態的,並且獨立於任何後端加載。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
連接器中繼資料
Publisher 特洛伊·泰勒
網站 https://instatus.com/
隱私策略 https://instatus.com/policies/privacy
類別 網站;IT 營運

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 (以「持有人API_Key」的形式) securestring 此 API 的 API 金鑰 (格式為「持有人API_Key」)

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

使用範本新增事件

使用範本將事件新增至頁面。

使用範本解決事件

解決具有範本的頁面上的事件。

刪除事件

刪除頁面上的事件。

刪除事件更新

刪除頁面上事件的更新。

刪除元件

刪除頁面上的元件。

刪除團隊成員

從頁面中刪除小組成員。

刪除狀態頁面

刪除狀態頁面。

刪除範本

刪除頁面的範本。

刪除維護

刪除頁面的維護。

刪除維護更新

刪除頁面上維護的更新。

取得事件

擷取頁面上的事件。

取得事件更新

擷取頁面事件的更新。

取得元件

擷取頁面上的元件。

取得狀態頁面

擷取您的狀態頁面清單。

取得狀態頁面元件

擷取所有狀態頁面元件的清單。

取得範本

擷取頁面的範本。

取得維護更新

擷取頁面上維護的更新。

取得頁面事件

擷取頁面的所有事件。

取得頁面範本

擷取所有頁面範本的清單。

取得頁面維護

擷取頁面的所有維護。

建立元件

在頁面上建立元件。

建立狀態頁面

根據您要求的參數建立新的狀態頁面。

新增事件

在頁面上新增事件。

新增事件更新

新增頁面事件的更新。

新增團隊成員

在頁面上將成員新增至您的團隊。

新增範本

建立頁面的範本。

新增維護

在頁面上新增維護。

新增維護更新

新增頁面上的維護更新。

新增訂閱者

將訂閱者新增至頁面。

更新事件

更新頁面上的事件。

更新元件

更新頁面上的元件。

更新狀態頁面

更新已建立的狀態頁面。

更新範本

更新頁面的範本。

更新維護

更新頁面上的維護。

獲得訂閱者

擷取頁面的訂閱者清單。

獲得隊友

檢索隊友清單。

移除訂閱者

從頁面中移除訂閱者。

編輯事件更新

編輯頁面上事件的更新。

編輯維護更新

編輯頁面上維護的更新。

進行維護

擷取頁面的維護。

使用範本新增事件

使用範本將事件新增至頁面。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

Template
template True string

模板。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

名稱翻譯 ID
nameTranslationId string

名稱翻譯識別碼。

通知
notify boolean

是否通知。

地位
status string

狀態。

Started
started string

啟動時。

已解決
resolved string

解決後。

持續時間
duration string

持續時間。

創建於
createdAt string

建立時。

更新於
updatedAt string

更新時。

自動化
automated boolean

是否自動化。

Impact
impact string

影響。

App ID
appId string

應用程式識別碼。

站台識別碼
siteId string

網站識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否從狀態頁面匯入。

使用範本解決事件

解決具有範本的頁面上的事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

Template
template True string

模板。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息轉譯 ID
messageTranslationId string

訊息轉譯識別碼。

地位
status string

狀態。

通知
notify boolean

是否通知。

Started
started string

啟動時。

Ended
ended string

結束時。

持續時間
duration string

持續時間。

創建於
createdAt string

建立時。

更新於
updatedAt string

更新時。

事件 ID
incidentId string

事件識別碼。

訊息HTML
messageHtml string

訊息 HTML.

訊息 HTML 翻譯 ID
messageHtmlTranslationId string

訊息 HTML 翻譯識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否。

刪除事件

刪除頁面上的事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

刪除事件更新

刪除頁面上事件的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

事件更新標識碼
incident_update_id True string

事件更新識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

刪除元件

刪除頁面上的元件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

元件識別碼
component_id True string

元件識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

刪除團隊成員

從頁面中刪除小組成員。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

會員編號
member_id True string

成員識別碼。

傳回

response
string

刪除狀態頁面

刪除狀態頁面。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

刪除範本

刪除頁面的範本。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

範本識別碼
template_id True string

範本識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

Message
message string

訊息。

創建於
createdAt string

建立時。

ID
site.id string

識別碼。

刪除維護

刪除頁面的維護。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

刪除維護更新

刪除頁面上維護的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

維護更新標識碼
maintenance_update_id True string

維護更新識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

取得事件

擷取頁面上的事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

Started
started string

啟動時。

已解決
resolved string

解決後。

更新
updates array of object
ID
updates.id string

識別碼。

Message
updates.message string

訊息。

訊息HTML
updates.messageHtml string

訊息 HTML.

地位
updates.status string

狀態。

通知
updates.notify boolean

是否通知。

Started
updates.started string

啟動時。

Ended
updates.ended string

結束時。

持續時間
updates.duration string

持續時間。

創建於
updates.createdAt string

建立時。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

取得事件更新

擷取頁面事件的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

事件更新標識碼
incident_update_id True string

事件更新識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

地位
status string

狀態。

通知
notify boolean

是否通知。

Started
started string

啟動時。

ID
incident.id string

識別碼。

名稱
incident.name string

名稱。

Started
incident.started string

啟動時。

地位
incident.status string

狀態。

Components
incident.components array of object
ID
incident.components.id string

識別碼。

名稱
incident.components.name string

名稱。

地位
incident.components.status string

狀態。

顯示正常運行時間
incident.components.showUptime boolean

是否顯示正常運行時間。

Subdomain
incident.components.site.subdomain string

子網域。

標誌網址
incident.components.site.logoUrl string

標誌 URL 位址。

名稱
incident.components.site.name string

名稱。

Slack 整合
incident.components.site.slackIntegrations array of string

Slack 整合。

Subscribers
incident.components.site.subscribers array of string

訂閱者。

Subscribers
incident.components.subscribers array of string

訂閱者。

取得元件

擷取頁面上的元件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

元件識別碼
component_id True string

元件識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

Description
description string

描述。

地位
status string

狀態。

獨特的電子郵件
uniqueEmail string

唯一的電子郵件地址。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

訂單
order integer

命令。

群體
group string

該小組。

取得狀態頁面

擷取您的狀態頁面清單。

參數

名稱 機碼 必要 類型 Description
頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

Subdomain
subdomain string

子網域。

名稱
name string

名稱。

標誌網址
logoUrl string

標誌 URL 位址。

網站圖示網址
faviconUrl string

網站圖示 URL 位址。

網站 URL
websiteUrl string

網站網址。

Custom Domain
customDomain string

自訂網域。

公開電子郵件
publicEmail string

公用電子郵件。

推特
twitter string

推特句柄。

地位
status string

狀態。

通過短信訂閱
subscribeBySms boolean

是否啟用 [透過簡訊訂閱]。

語言
language string

語言。

使用大標頭
useLargeHeader boolean

是否使用大標頭。

品牌顏色
brandColor string

品牌顏色。

確定顏色
okColor string

OK 顏色。

破壞的顏色
disruptedColor string

被打亂的顏色。

退色
degradedColor string

退化的顏色。

羽絨顏色
downColor string

羽絨顏色。

注意顏色
noticeColor string

通知顏色。

未知顏色
unknownColor string

未知的顏色。

Google Analytics
googleAnalytics string

谷歌分析。

簡訊服務
smsService string

簡訊服務。

元中的 HTML
htmlInMeta string

meta 中的 HTML。

標頭上方的 HTML
htmlAboveHeader string

上面的 HTML 標頭。

標頭下方的 HTML
htmlBelowHeader string

下面的 HTML 標頭。

頁尾上方的 HTML
htmlAboveFooter string

頁尾上方的 HTML。

頁尾下方的 HTML
htmlBelowFooter string

頁尾下方的 HTML。

下面的 HTML 摘要
htmlBelowSummary string

下面的 HTML 摘要。

推出日期
launchDate string

發布日期。

CSS 全球
cssGlobal string

CSS 全域。

已上線
onboarded string

入職的。

創建於
createdAt string

建立時。

更新於
updatedAt string

更新時。

取得狀態頁面元件

擷取所有狀態頁面元件的清單。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

獨特的電子郵件
uniqueEmail string

唯一的電子郵件地址。

Description
description string

描述。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

訂單
order integer

命令。

群體
group string

該小組。

取得範本

擷取頁面的範本。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

範本識別碼
template_id True string

範本識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

類型
type string

型別。

名稱
name string

名稱。

名稱翻譯 ID
nameTranslationId string

名稱翻譯識別碼。

Message
message string

訊息。

訊息轉譯 ID
messageTranslationId string

訊息轉譯識別碼。

訊息HTML
messageHtml string

訊息 HTML.

訊息 HTML 翻譯 ID
messageHtmlTranslationId string

訊息 HTML 翻譯識別碼。

地位
status string

狀態。

通知
notify boolean

是否通知。

創建於
createdAt string

建立時。

站台識別碼
siteId string

網站識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否從狀態頁面匯入。

刪除時間
deletedAt string

刪除時。

Components
components array of string

組件。

名稱
translations.name string

名稱。

Message
translations.message string

訊息。

取得維護更新

擷取頁面上維護的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

維護更新標識碼
maintenance_update_id True string

維護更新識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

通知
notify boolean

是否通知。

Started
started string

啟動時。

地位
status string

狀態。

ID
maintenance.id string

識別碼。

名稱
maintenance.name string

名稱。

開始
maintenance.start string

開始。

地位
maintenance.status string

狀態。

Components
maintenance.components array of object
ID
maintenance.components.id string

識別碼。

名稱
maintenance.components.name string

名稱。

地位
maintenance.components.status string

狀態。

顯示正常運行時間
maintenance.components.showUptime boolean

是否顯示正常運行時間。

ID
maintenance.components.site.id string

識別碼。

名稱
maintenance.components.site.name string

名稱。

Subdomain
maintenance.components.site.subdomain string

子網域。

顏色
maintenance.components.site.color string

色彩。

標誌網址
maintenance.components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
maintenance.components.site.publicEmail string

公用電子郵件地址。

取得頁面事件

擷取頁面的所有事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

地位
status string

狀態。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

名稱
name string

名稱。

Started
started string

啟動時。

地位
status string

狀態。

已解決
resolved string

解決後。

更新
updates array of object
ID
updates.id string

識別碼。

Message
updates.message string

訊息。

訊息HTML
updates.messageHtml string

訊息 HTML.

地位
updates.status string

狀態。

通知
updates.notify boolean

是否通知。

Started
updates.started string

啟動時。

Ended
updates.ended string

結束時。

持續時間
updates.duration string

持續時間。

創建於
updates.createdAt string

建立時。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

取得頁面範本

擷取所有頁面範本的清單。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

類型
type string

型別。

名稱
name string

名稱。

名稱翻譯 ID
nameTranslationId string

名稱翻譯識別碼。

Message
message string

訊息。

訊息轉譯 ID
messageTranslationId string

訊息轉譯識別碼。

訊息HTML
messageHtml string

訊息 HTML.

訊息 HTML 翻譯 ID
messageHtmlTranslationId string

訊息 HTML 翻譯識別碼。

地位
status string

狀態。

通知
notify boolean

是否通知。

創建於
createdAt string

建立時。

站台識別碼
siteId string

網站識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否從狀態頁面匯入。

刪除時間
deletedAt string

刪除時。

Components
components array of object
ID
components.id string

識別碼。

地位
components.status string

狀態。

元件識別碼
components.componentId string

元件識別碼。

範本識別碼
components.templateId string

範本識別碼。

匯入自狀態頁面
components.importedFromStatuspage boolean

是否從狀態頁面匯入。

名稱
translations.name string

名稱。

Message
translations.message string

訊息。

取得頁面維護

擷取頁面的所有維護。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

開始
start string

開始。

持續時間
duration integer

持續時間。

通知開始
notifyStart boolean

是否通知開始。

通知結束
notifyEnd boolean

是否通知結束。

儘早通知
notifyEarly boolean

是否提前通知。

通知會議記錄
notifyMinutes integer

通知會議記錄。

自動啟動
autoStart boolean

是否自動啟動。

自動結束
autoEnd boolean

是否自動結束。

更新
updates array of object
ID
updates.id string

識別碼。

Message
updates.message string

訊息。

訊息HTML
updates.messageHtml string

訊息 HTML.

地位
updates.status string

狀態。

通知
updates.notify boolean

是否通知。

Started
updates.started string

啟動時。

Ended
updates.ended string

結束時。

持續時間
updates.duration string

持續時間。

創建於
updates.createdAt string

建立時。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

建立元件

在頁面上建立元件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

名稱
name string

名稱。

Description
description string

描述。

地位
status string

狀態。

訂單
order integer

命令。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

分組
grouped boolean

是否分組。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

Description
description string

描述。

獨特的電子郵件
uniqueEmail string

唯一的電子郵件地址。

地位
status string

狀態。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

訂單
order integer

命令。

群體
group string

該小組。

建立狀態頁面

根據您要求的參數建立新的狀態頁面。

參數

名稱 機碼 必要 類型 Description
Email
email string

電子郵件地址。

名稱
name string

名稱。

Subdomain
subdomain string

子網域。

Components
components array of string

組件。

標誌網址
logoUrl string

標誌 URL 位址。

網站圖示網址
faviconUrl string

網站圖示 URL 位址。

網站 URL
websiteUrl string

網站網址。

語言
language string

語言。

使用大標頭
useLargeHeader boolean

是否使用大標頭。

品牌顏色
brandColor string

品牌顏色。

確定顏色
okColor string

OK 顏色。

破壞的顏色
disruptedColor string

被打亂的顏色。

退色
degradedColor string

退化的顏色。

羽絨顏色
downColor string

羽絨顏色。

注意顏色
noticeColor string

通知顏色。

未知顏色
unknownColor string

未知的顏色。

Google Analytics
googleAnalytics string

谷歌分析。

通過短信訂閱
subscribeBySms boolean

是否通過短信訂閱。

簡訊服務
smsService string

簡訊服務。

Twilio SID
twilioSid string

Twilio SID。

Twilio 代幣
twilioToken string

Twilio 令牌。

Twilio 寄件者
twilioSender string

Twilio 寄件者。

元中的 HTML
htmlInMeta string

meta 中的 HTML。

標頭上方的 HTML
htmlAboveHeader string

上面的 HTML 標頭。

標頭下方的 HTML
htmlBelowHeader string

下面的 HTML 標頭。

頁尾上方的 HTML
htmlAboveFooter string

頁尾上方的 HTML。

頁尾下方的 HTML
htmlBelowFooter string

頁尾下方的 HTML。

下面的 HTML 摘要
htmlBelowSummary string

下面的 HTML 摘要。

CSS 全球
cssGlobal string

CSS 全域。

推出日期
launchDate string

發布日期。

日期格式
dateFormat string

日期格式。

日期格式簡短
dateFormatShort string

日期格式簡短。

時間格式
timeFormat string

時間格式。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

創建於
createdAt string

建立時。

Subdomain
subdomain string

子網域。

標誌網址
logoUrl string

標誌 URL 位址。

網站圖示網址
faviconUrl string

網站圖示 URL 位址。

網站 URL
websiteUrl string

網站網址。

名稱
name string

名稱。

地位
status string

狀態。

顏色
color string

色彩。

語言
language string

語言。

Google Analytics
googleAnalytics string

谷歌分析。

公開電子郵件
publicEmail string

公用電子郵件地址。

Custom Domain
customDomain string

自訂網域。

使用大標頭
useLargeHeader boolean

是否使用大標頭。

停用深色模式
disableDarkMode string

禁用的深色模式。

推特
twitter string

推特句柄。

通過短信訂閱
subscribeBySms string

通過短信訂閱。

品牌顏色
brandColor string

品牌顏色。

確定顏色
okColor string

OK 顏色。

破壞的顏色
disruptedColor string

被打亂的顏色。

羽絨顏色
downColor string

羽絨顏色。

退色
degradedColor string

退化的顏色。

注意顏色
noticeColor string

通知顏色。

元中的 HTML
htmlInMeta string

meta 中的 HTML。

標頭上方的 HTML
htmlAboveHeader string

上面的 HTML 標頭。

標頭下方的 HTML
htmlBelowHeader string

下面的 HTML 標頭。

頁尾上方的 HTML
htmlAboveFooter string

頁尾上方的 HTML。

頁尾下方的 HTML
htmlBelowFooter string

頁尾下方的 HTML。

下面的 HTML 摘要
htmlBelowSummary string

下面的 HTML 摘要。

CSS 全球
cssGlobal string

CSS 全域。

已上線
onboarded string

入職的。

推出日期
launchDate string

發布日期。

日期格式
dateFormat string

日期格式。

日期格式簡短
dateFormatShort string

日期格式簡短。

時間格式
timeFormat string

時間格式。

私人
private boolean

無論是私人。

使用允許清單
useAllowList boolean

是否使用允許清單。

允許清單
allowList array of string

允許清單。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

訂單
components.order string

命令。

群體
components.group string

該小組。

事故
components.incidents array of string

事件。

新增事件

在頁面上新增事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

名稱
name string

名稱。

Message
message string

訊息。

Components
components array of string

組件。

Started
started string

啟動時。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

Started
started string

啟動時。

已解決
resolved string

解決後。

更新
updates array of string

更新。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

新增事件更新

新增頁面事件的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

Message
message string

訊息。

Components
components array of string

組件。

Started
started string

啟動時。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

地位
status string

狀態。

通知
notify boolean

是否通知。

Started
started string

啟動時。

ID
incident.id string

識別碼。

名稱
incident.name string

名稱。

Started
incident.started string

啟動時。

地位
incident.status string

狀態。

Components
incident.components array of object
ID
incident.components.id string

識別碼。

名稱
incident.components.name string

名稱。

地位
incident.components.status string

狀態。

顯示正常運行時間
incident.components.showUptime boolean

是否顯示正常運行時間。

Subdomain
incident.components.site.subdomain string

子網域。

標誌網址
incident.components.site.logoUrl string

標誌 URL 位址。

名稱
incident.components.site.name string

名稱。

Slack 整合
incident.components.site.slackIntegrations array of string

Slack 整合。

Subscribers
incident.components.site.subscribers array of string

訂閱者。

Subscribers
incident.components.subscribers array of string

訂閱者。

新增團隊成員

在頁面上將成員新增至您的團隊。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

Email
email string

電子郵件地址。

傳回

response
string

新增範本

建立頁面的範本。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

Subdomain
subdomain string

子網域。

類型
type string

型別。

名稱
name string

名稱。

Message
message string

訊息。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

類型
type string

型別。

名稱
name string

名稱。

名稱翻譯 ID
nameTranslationId string

名稱翻譯識別碼。

Message
message string

訊息。

訊息轉譯 ID
messageTranslationId string

訊息轉譯識別碼。

訊息HTML
messageHtml string

訊息 HTML.

訊息 HTML 翻譯 ID
messageHtmlTranslationId string

訊息 HTML 翻譯識別碼。

地位
status string

狀態。

通知
notify boolean

是否通知。

創建於
createdAt string

建立時。

站台識別碼
siteId string

網站識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否從狀態頁面匯入。

刪除時間
deletedAt string

刪除時。

Components
components array of string

組件。

名稱
translations.name string

名稱。

Message
translations.message string

訊息。

新增維護

在頁面上新增維護。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

名稱
name string

名稱。

Message
message string

訊息。

Components
components array of string

組件。

開始
start string

開始。

結束
end string

結束。

地位
status string

狀態。

通知
notify boolean

是否通知。

持續時間
duration integer

持續時間。

通知開始
notifyStart boolean

是否通知開始。

通知結束
notifyEnd boolean

是否通知結束。

儘早通知
notifyEarly boolean

是否提前通知。

通知會議記錄
notifyMinutes integer

通知會議記錄。

自動啟動
autoStart boolean

是否自動啟動。

自動結束
autoEnd boolean

是否自動結束。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

持續時間
duration string

持續時間。

開始
start string

開始。

結束
end string

結束。

地位
status string

狀態。

更新
updates array of string

更新。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

新增維護更新

新增頁面上的維護更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

Message
message string

訊息。

Components
components array of string

組件。

Started
started string

啟動時。

結束
end string

結束。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

通知
notify boolean

是否通知。

Started
started string

啟動時。

地位
status string

狀態。

ID
maintenance.id string

識別碼。

名稱
maintenance.name string

名稱。

開始
maintenance.start string

開始。

地位
maintenance.status string

狀態。

Components
maintenance.components array of object
ID
maintenance.components.id string

識別碼。

名稱
maintenance.components.name string

名稱。

地位
maintenance.components.status string

狀態。

顯示正常運行時間
maintenance.components.showUptime boolean

是否顯示正常運行時間。

Subscribers
maintenance.components.subscribers array of string

訂閱者。

ID
maintenance.components.site.id string

識別碼。

名稱
maintenance.components.site.name string

名稱。

Subdomain
maintenance.components.site.subdomain string

子網域。

顏色
maintenance.components.site.color string

色彩。

標誌網址
maintenance.components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
maintenance.components.site.publicEmail string

公用電子郵件地址。

Subscribers
maintenance.components.site.subscribers array of string

訂閱者。

新增訂閱者

將訂閱者新增至頁面。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

Email
email string

電子郵件地址。

全部
all boolean

無論全部。

自動確認
autoConfirm boolean

是否自動確認。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Email
email string

電子郵件地址。

ID
site.id string

識別碼。

名稱
site.name string

名稱。

標誌網址
site.logoUrl string

標誌 URL 位址。

Subdomain
site.subdomain string

子網域。

公開電子郵件
site.publicEmail string

公用電子郵件地址。

語言
site.language string

語言。

更新事件

更新頁面上的事件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

名稱
name string

名稱。

Components
components array of string

組件。

Started
started string

啟動時。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

Started
started string

啟動時。

已解決
resolved string

解決後。

更新
updates array of string

更新。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

更新元件

更新頁面上的元件。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

元件識別碼
component_id True string

元件識別碼。

名稱
name string

名稱。

Description
description string

描述。

地位
status string

狀態。

訂單
order integer

命令。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

分組
grouped boolean

是否分組。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

獨特的電子郵件
uniqueEmail string

唯一的電子郵件地址。

地位
status string

狀態。

Description
description string

描述。

顯示正常運行時間
showUptime boolean

是否顯示正常運行時間。

訂單
order integer

命令。

群體
group string

該小組。

更新狀態頁面

更新已建立的狀態頁面。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

Subdomain
subdomain string

子網域。

標誌網址
logoUrl string

標誌 URL 位址。

網站圖示網址
faviconUrl string

網站圖示 URL 位址。

網站 URL
websiteUrl string

網站網址。

語言
language string

語言。

公開電子郵件
publicEmail string

公用電子郵件地址。

使用大標頭
useLargeHeader boolean

是否使用大標頭。

品牌顏色
brandColor string

品牌顏色。

確定顏色
okColor string

OK 顏色。

破壞的顏色
disruptedColor string

被打亂的顏色。

退色
degradedColor string

退化的顏色。

羽絨顏色
downColor string

羽絨顏色。

注意顏色
noticeColor string

通知顏色。

未知顏色
unknownColor string

未知的顏色。

Google Analytics
googleAnalytics string

谷歌分析。

通過短信訂閱
subscribeBySms boolean

是否通過短信訂閱。

簡訊服務
smsService string

簡訊服務。

Twilio SID
twilioSid string

Twilio SID。

Twilio 代幣
twilioToken string

Twilio 令牌。

Twilio 寄件者
twilioSender string

Twilio 寄件者。

元中的 HTML
htmlInMeta string

meta 中的 HTML。

標頭上方的 HTML
htmlAboveHeader string

上面的 HTML 標頭。

標頭下方的 HTML
htmlBelowHeader string

下面的 HTML 標頭。

頁尾上方的 HTML
htmlAboveFooter string

頁尾上方的 HTML。

頁尾下方的 HTML
htmlBelowFooter string

頁尾下方的 HTML。

下面的 HTML 摘要
htmlBelowSummary string

下面的 HTML 摘要。

CSS 全球
cssGlobal string

CSS 全域。

推出日期
launchDate string

發布日期。

日期格式
dateFormat string

日期格式。

日期格式簡短
dateFormatShort string

日期格式簡短。

時間格式
timeFormat string

時間格式。

私人
private boolean

無論是私人。

使用允許清單
useAllowList boolean

是否使用允許清單。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

創建於
createdAt string

建立時。

Subdomain
subdomain string

子網域。

名稱
name string

名稱。

地位
status string

狀態。

標誌網址
logoUrl string

標誌 URL 位址。

網站圖示網址
faviconUrl string

網站圖示 URL 位址。

網站 URL
websiteUrl string

網站網址。

顏色
color string

色彩。

語言
language string

語言。

Google Analytics
googleAnalytics string

谷歌分析。

公開電子郵件
publicEmail string

公用電子郵件地址。

Custom Domain
customDomain string

自訂網域。

使用大標頭
useLargeHeader boolean

是否使用大標頭。

停用深色模式
disableDarkMode string

禁用的深色模式。

推特
twitter string

推特句柄。

通過短信訂閱
subscribeBySms string

通過短信訂閱。

品牌顏色
brandColor string

品牌顏色。

確定顏色
okColor string

OK 顏色。

破壞的顏色
disruptedColor string

被打亂的顏色。

羽絨顏色
downColor string

羽絨顏色。

退色
degradedColor string

退化的顏色。

注意顏色
noticeColor string

通知顏色。

元中的 HTML
htmlInMeta string

meta 中的 HTML。

標頭上方的 HTML
htmlAboveHeader string

上面的 HTML 標頭。

標頭下方的 HTML
htmlBelowHeader string

下面的 HTML 標頭。

頁尾上方的 HTML
htmlAboveFooter string

頁尾上方的 HTML。

頁尾下方的 HTML
htmlBelowFooter string

頁尾下方的 HTML。

下面的 HTML 摘要
htmlBelowSummary string

下面的 HTML 摘要。

CSS 全球
cssGlobal string

CSS 全域。

已上線
onboarded string

入職的。

推出日期
launchDate string

發布日期。

日期格式
dateFormat string

日期格式。

日期格式簡短
dateFormatShort string

日期格式簡短。

時間格式
timeFormat string

時間格式。

私人
private boolean

無論是私人。

使用允許清單
useAllowList boolean

是否使用允許清單。

允許清單
allowList array of

允許清單。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

訂單
components.order string

命令。

群體
components.group string

該小組。

事故
components.incidents array of string

事件。

更新範本

更新頁面的範本。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

範本識別碼
template_id True string

範本識別碼。

類型
type string

型別。

名稱
name string

名稱。

Message
message string

訊息。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

類型
type string

型別。

名稱
name string

名稱。

名稱翻譯 ID
nameTranslationId string

名稱翻譯識別碼。

Message
message string

訊息。

訊息轉譯 ID
messageTranslationId string

訊息轉譯識別碼。

訊息HTML
messageHtml string

訊息 HTML.

訊息 HTML 翻譯 ID
messageHtmlTranslationId string

訊息 HTML 翻譯識別碼。

地位
status string

狀態。

通知
notify boolean

是否通知。

創建於
createdAt string

建立時。

站台識別碼
siteId string

網站識別碼。

匯入自狀態頁面
importedFromStatuspage boolean

是否從狀態頁面匯入。

刪除時間
deletedAt string

刪除時。

Components
components array of object
ID
components.id string

識別碼。

地位
components.status string

狀態。

元件識別碼
components.componentId string

元件識別碼。

範本識別碼
components.templateId string

範本識別碼。

匯入自狀態頁面
components.importedFromStatuspage boolean

是否從狀態頁面匯入。

名稱
translations.name string

名稱。

Message
translations.message string

訊息。

更新維護

更新頁面上的維護。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

名稱
name string

名稱。

Message
message string

訊息。

Components
components array of string

組件。

開始
start string

開始。

結束
end string

結束。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

開始
start string

開始。

持續時間
duration string

持續時間。

更新
updates array of object
ID
updates.id string

識別碼。

Message
updates.message string

訊息。

訊息HTML
updates.messageHtml string

訊息 HTML.

地位
updates.status string

狀態。

通知
updates.notify boolean

是否通知。

Started
updates.started string

啟動時。

Ended
updates.ended string

結束時。

持續時間
updates.duration string

持續時間。

創建於
updates.createdAt string

建立時。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

獲得訂閱者

擷取頁面的訂閱者清單。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

Email
email string

電子郵件地址。

電話
phone string

電話號碼。

Webhook
webhook string

Webhook。

Webhook 電子郵件
webhookEmail string

Webhook 電子郵件地址。

已確認
confirmed boolean

是否確認。

全部
all boolean

無論全部。

Components
components array of string

組件。

獲得隊友

檢索隊友清單。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

頁面
page integer

頁面。

每頁數量
per_page integer

每頁的數目。

傳回

名稱 路徑 類型 Description
array of object
ID
id string

識別碼。

ID
user.id string

識別碼。

名稱
user.name string

名稱。

Email
user.email string

電子郵件地址。

阿凡達
user.avatar string

化身。

移除訂閱者

從頁面中移除訂閱者。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

訂閱者 ID
subscriber_id True string

訂閱者 ID。

傳回

response
string

編輯事件更新

編輯頁面上事件的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

事件 ID
incident_id True string

事件識別碼。

事件更新標識碼
incident_update_id True string

事件更新識別碼。

Message
message string

訊息。

Components
components array of string

組件。

Started
started string

啟動時。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

地位
status string

狀態。

通知
notify boolean

是否通知。

Started
started string

啟動時。

ID
incident.id string

識別碼。

名稱
incident.name string

名稱。

Started
incident.started string

啟動時。

地位
incident.status string

狀態。

Components
incident.components array of object
ID
incident.components.id string

識別碼。

名稱
incident.components.name string

名稱。

地位
incident.components.status string

狀態。

顯示正常運行時間
incident.components.showUptime boolean

是否顯示正常運行時間。

Subdomain
incident.components.site.subdomain string

子網域。

標誌網址
incident.components.site.logoUrl string

標誌 URL 位址。

名稱
incident.components.site.name string

名稱。

Slack 整合
incident.components.site.slackIntegrations array of string

Slack 整合。

Subscribers
incident.components.site.subscribers array of string

訂閱者。

Subscribers
incident.components.subscribers array of string

訂閱者。

編輯維護更新

編輯頁面上維護的更新。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

維護更新標識碼
maintenance_update_id True string

維護更新識別碼。

Message
message string

訊息。

Components
components array of string

組件。

Started
started string

啟動時。

結束
end string

結束。

地位
status string

狀態。

通知
notify boolean

是否通知。

ID
id string

識別碼。

地位
status string

狀態。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

Message
message string

訊息。

訊息HTML
messageHtml string

訊息 HTML.

通知
notify boolean

是否通知。

Started
started string

啟動時。

地位
status string

狀態。

ID
maintenance.id string

識別碼。

名稱
maintenance.name string

名稱。

開始
maintenance.start string

開始。

地位
maintenance.status string

狀態。

Components
maintenance.components array of object
ID
maintenance.components.id string

識別碼。

名稱
maintenance.components.name string

名稱。

地位
maintenance.components.status string

狀態。

顯示正常運行時間
maintenance.components.showUptime boolean

是否顯示正常運行時間。

使用者
maintenance.components.subscribers array of string

訂閱者。

ID
maintenance.components.site.id string

識別碼。

名稱
maintenance.components.site.name string

名稱。

Subdomain
maintenance.components.site.subdomain string

子網域。

顏色
maintenance.components.site.color string

色彩。

標誌網址
maintenance.components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
maintenance.components.site.publicEmail string

公用電子郵件地址。

Subscribers
maintenance.components.site.subscribers array of string

訂閱者。

進行維護

擷取頁面的維護。

參數

名稱 機碼 必要 類型 Description
頁面 ID
page_id True string

頁面識別碼。

維護 ID
maintenance_id True string

維護識別碼。

傳回

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

名稱。

地位
status string

狀態。

開始
start string

開始。

持續時間
duration integer

持續時間。

通知開始
notifyStart boolean

是否通知開始。

通知結束
notifyEnd boolean

是否通知結束。

儘早通知
notifyEarly boolean

是否提前通知。

通知會議記錄
notifyMinutes integer

通知會議記錄。

自動啟動
autoStart boolean

是否自動啟動。

自動結束
autoEnd boolean

是否自動結束。

更新
updates array of object
ID
updates.id string

識別碼。

Message
updates.message string

訊息。

訊息HTML
updates.messageHtml string

訊息 HTML.

地位
updates.status string

狀態。

通知
updates.notify boolean

是否通知。

Started
updates.started string

啟動時。

Ended
updates.ended string

結束時。

持續時間
updates.duration string

持續時間。

創建於
updates.createdAt string

建立時。

Components
components array of object
ID
components.id string

識別碼。

名稱
components.name string

名稱。

地位
components.status string

狀態。

顯示正常運行時間
components.showUptime boolean

是否顯示正常運行時間。

ID
components.site.id string

識別碼。

名稱
components.site.name string

名稱。

Subdomain
components.site.subdomain string

子網域。

顏色
components.site.color string

色彩。

標誌網址
components.site.logoUrl string

標誌 URL 位址。

公開電子郵件
components.site.publicEmail string

公用電子郵件地址。

定義

字串

這是基本資料類型「string」。