次の方法で共有

Instatus (独立した発行元) (プレビュー)

ダウンタイムに対する回復力があり、読み込み速度が速い状態ページを取得します。 状態ページは静的であり、どのバックエンドからも独立して読み込まれます。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 トロイ・テイラー
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
コネクタ メタデータ
Publisher トロイ・テイラー
Website https://instatus.com/
プライバシー ポリシー https://instatus.com/policies/privacy
カテゴリ Web サイト;IT 運用

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
API キー ('Bearer API_Key' の形式) securestring この API の API キー ("Bearer API_Key" という形式) 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

[更新の状態] ページ

作成された状態ページを更新します。
[状態の作成] ページ

要求されたパラメーターに基づいて新しい状態ページを作成します。
[状態の削除] ページ

状態ページを削除します。
インシデントの削除

ページ上のインシデントを削除します。
インシデントの更新を削除する

ページ上のインシデントの更新を削除します。
インシデントの更新を編集する

ページ上のインシデントの更新を編集します。
インシデントの更新プログラムを取得する

ページ インシデントの更新プログラムを取得します。
インシデントの更新プログラムを追加する

ページ インシデントに更新プログラムを追加します。
インシデントの追加

ページにインシデントを追加します。
インシデントを取得する

ページ上のインシデントを取得します。
インシデントを更新する

ページ上のインシデントを更新します。
コンポーネントの作成

ページ上にコンポーネントを作成します。
コンポーネントの削除

ページ上のコンポーネントを削除します。
コンポーネントの取得

ページ上のコンポーネントを取得します。
コンポーネントの更新

ページ上のコンポーネントを更新します。
サブスクライバーの削除

ページからサブスクライバーを削除します。
サブスクライバーの追加

ページにサブスクライバーを追加します。
サブスクライバーを取得する

ページのサブスクライバーの一覧を取得します。
チーム メンバーの削除

ページからチーム メンバーを削除します。
チーム メンバーの追加

ページでチームにメンバーを追加します。
チームメイトを獲得する

チームメイトのリストを取得します。
テンプレートの削除

ページのテンプレートを削除します。
テンプレートの更新

ページのテンプレートを更新します。
テンプレートの追加

ページのテンプレートを作成します。
テンプレートを使用してインシデントを解決する

テンプレートを使用してページ上のインシデントを解決します。
テンプレートを使用してインシデントを追加する

テンプレートを使用してページにインシデントを追加します。
テンプレートを取得する

ページのテンプレートを取得します。
ページ インシデントを取得する

ページのすべてのインシデントを取得します。
ページ テンプレートを取得する

すべてのページ テンプレートの一覧を取得します。
ページのメンテナンスを取得する

ページのすべてのメンテナンスを取得します。
メンテナンスの削除

ページのメンテナンスを削除します。
メンテナンスの追加

ページにメンテナンスを追加します。
メンテナンスを取得する

ページのメンテナンスを取得します。
メンテナンス更新プログラムの削除

ページのメンテナンスに対する更新を削除します。
メンテナンス更新プログラムの編集

ページのメンテナンスの更新を編集します。
メンテナンス更新プログラムを取得する

ページのメンテナンスの更新プログラムを取得します。
メンテナンス更新プログラムを追加する

ページのメンテナンスに更新プログラムを追加します。
更新プログラムのメンテナンス

ページのメンテナンスを更新します。
状態ページのコンポーネントを取得する

すべてのステータス ページ コンポーネントの一覧を取得します。
状態ページを取得する

状態ページの一覧を取得します。

[更新の状態] ページ

操作 ID:
PagePut

作成された状態ページを更新します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ID
 id string

識別子。
名前
 name string

名前。
ステータス
 status string

状態。
サブドメイン
 subdomain string

サブドメイン。
ロゴ URL
 logoUrl string

ロゴの URL アドレス。
Favicon URL
 faviconUrl string

favicon URL アドレス。
Web サイトの URL
 websiteUrl string

Web サイトの URL アドレス。
Language
 language string

言語。
パブリック メール
 publicEmail string

パブリック メール アドレス。
大きなヘッダーを使用する
 useLargeHeader boolean

大きなヘッダーを使用するかどうか。
ブランドの色
 brandColor string

ブランドの色。
OK の色
 okColor string

OK の色。
中断された色
 disruptedColor string

中断された色。
低下した色
 degradedColor string

低下した色。
下の色
 downColor string

下の色。
色に注目する
 noticeColor string

通知の色。
不明な色
 unknownColor string

不明な色。
Google アナリティクス
 googleAnalytics string

Google アナリティクス。
SMS でサブスクライブする
 subscribeBySms boolean

SMS でサブスクライブするかどうか。
SMS サービス
 smsService string

SMS サービス。
Twilio SID
 twilioSid string

Twilio SID。
Twilio トークン
 twilioToken string

Twilio トークン。
Twilio Sender
 twilioSender string

Twilio 送信者。
メタ内の HTML
 htmlInMeta string

メタ内の 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

許可リストを使用するかどうか。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
Created At
 createdAt string

作成時に指定します。
サブドメイン
 subdomain string

サブドメイン。
名前
 name string

名前。
ステータス
 status string

状態。
ロゴ URL
 logoUrl string

ロゴの URL アドレス。
Favicon URL
 faviconUrl string

favicon URL アドレス。
Web サイトの URL
 websiteUrl string

Web サイトの URL アドレス。
色
 color string

色。
Language
 language string

言語。
Google アナリティクス
 googleAnalytics string

Google アナリティクス。
パブリック メール
 publicEmail string

パブリック メール アドレス。
Custom Domain
 customDomain string

カスタム ドメイン。
大きなヘッダーを使用する
 useLargeHeader boolean

大きなヘッダーを使用するかどうか。
ダーク モードを無効にする
 disableDarkMode string

無効なダーク モード。
ツイッター
 twitter string

Twitter ハンドル。
SMS でサブスクライブする
 subscribeBySms string

SMS によるサブスクライブ。
ブランドの色
 brandColor string

ブランドの色。
OK の色
 okColor string

OK の色。
中断された色
 disruptedColor string

中断された色。
下の色
 downColor string

下の色。
低下した色
 degradedColor string

低下した色。
色に注目する
 noticeColor string

通知の色。
メタ内の HTML
 htmlInMeta string

メタ内の 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

インシデント。

[状態の作成] ページ

操作 ID:
PagePost

要求されたパラメーターに基づいて新しい状態ページを作成します。

パラメーター

名前 キー 必須 型 説明
Email
 email string

電子メール アドレス。
名前
 name string

名前。
サブドメイン
 subdomain string

サブドメイン。
Components
 components array of string

コンポーネント。
ロゴ URL
 logoUrl string

ロゴの URL アドレス。
Favicon URL
 faviconUrl string

favicon URL アドレス。
Web サイトの URL
 websiteUrl string

Web サイトの URL アドレス。
Language
 language string

言語。
大きなヘッダーを使用する
 useLargeHeader boolean

大きなヘッダーを使用するかどうか。
ブランドの色
 brandColor string

ブランドの色。
OK の色
 okColor string

OK の色。
中断された色
 disruptedColor string

中断された色。
低下した色
 degradedColor string

低下した色。
下の色
 downColor string

下の色。
色に注目する
 noticeColor string

通知の色。
不明な色
 unknownColor string

不明な色。
Google アナリティクス
 googleAnalytics string

Google アナリティクス。
SMS でサブスクライブする
 subscribeBySms boolean

SMS でサブスクライブするかどうか。
SMS サービス
 smsService string

SMS サービス。
Twilio SID
 twilioSid string

Twilio SID。
Twilio トークン
 twilioToken string

Twilio トークン。
Twilio Sender
 twilioSender string

Twilio 送信者。
メタ内の HTML
 htmlInMeta string

メタ内の 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

時刻の形式。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
Created At
 createdAt string

作成時に指定します。
サブドメイン
 subdomain string

サブドメイン。
ロゴ URL
 logoUrl string

ロゴの URL アドレス。
Favicon URL
 faviconUrl string

favicon URL アドレス。
Web サイトの URL
 websiteUrl string

Web サイトの URL アドレス。
名前
 name string

名前。
ステータス
 status string

状態。
色
 color string

色。
Language
 language string

言語。
Google アナリティクス
 googleAnalytics string

Google アナリティクス。
パブリック メール
 publicEmail string

パブリック メール アドレス。
Custom Domain
 customDomain string

カスタム ドメイン。
大きなヘッダーを使用する
 useLargeHeader boolean

大きなヘッダーを使用するかどうか。
ダーク モードを無効にする
 disableDarkMode string

無効なダーク モード。
ツイッター
 twitter string

Twitter ハンドル。
SMS でサブスクライブする
 subscribeBySms string

SMS によるサブスクライブ。
ブランドの色
 brandColor string

ブランドの色。
OK の色
 okColor string

OK の色。
中断された色
 disruptedColor string

中断された色。
下の色
 downColor string

下の色。
低下した色
 degradedColor string

低下した色。
色に注目する
 noticeColor string

通知の色。
メタ内の HTML
 htmlInMeta string

メタ内の 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

インシデント。

[状態の削除] ページ

操作 ID:
PageDelete

状態ページを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

インシデントの削除

操作 ID:
IncidentDelete

ページ上のインシデントを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

インシデントの更新を削除する

操作 ID:
IncidentUpdateDelete

ページ上のインシデントの更新を削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
インシデント更新 ID
 incident_update_id True string

インシデント更新識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

インシデントの更新を編集する

操作 ID:
IncidentUpdatePut

ページ上のインシデントの更新を編集します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
インシデント更新 ID
 incident_update_id True string

インシデント更新識別子。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
ステータス
 status string

状態。
Notify
 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

アップタイムを表示するかどうか。
サブドメイン
 incident.components.site.subdomain string

サブドメイン。
ロゴ URL
 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

サブスクライバー。

インシデントの更新プログラムを取得する

操作 ID:
IncidentUpdateGet

ページ インシデントの更新プログラムを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
インシデント更新 ID
 incident_update_id True string

インシデント更新識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
ステータス
 status string

状態。
Notify
 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

アップタイムを表示するかどうか。
サブドメイン
 incident.components.site.subdomain string

サブドメイン。
ロゴ URL
 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

サブスクライバー。

インシデントの更新プログラムを追加する

操作 ID:
IncidentUpdatePost

ページ インシデントに更新プログラムを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
ステータス
 status string

状態。
Notify
 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

アップタイムを表示するかどうか。
サブドメイン
 incident.components.site.subdomain string

サブドメイン。
ロゴ URL
 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

サブスクライバー。

インシデントの追加

操作 ID:
IncidentPost

ページにインシデントを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

インシデントを取得する

操作 ID:
IncidentGet

ページ上のインシデントを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
ステータス
 status string

状態。
Started
 started string

起動時。
解決済み
 resolved string

解決された場合。
最新情報
 updates array of object
ID
 updates.id string

識別子。
メッセージ
 updates.message string

メッセージ。
メッセージ HTML
 updates.messageHtml string

メッセージ HTML。
ステータス
 updates.status string

状態。
Notify
 updates.notify boolean

通知するかどうか。
Started
 updates.started string

起動時。
Ended
 updates.ended string

終了したとき。
期間
 updates.duration string

期間。
Created At
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

インシデントを更新する

操作 ID:
IncidentPut

ページ上のインシデントを更新します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
名前
 name string

名前。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

コンポーネントの作成

操作 ID:
ComponentPost

ページ上にコンポーネントを作成します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
名前
 name string

名前。
Description
 description string

説明。
ステータス
 status string

状態。
注文
 order integer

順序。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
分類
 grouped boolean

グループ化されているかどうか。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
Description
 description string

説明。
一意の電子メール
 uniqueEmail string

一意の電子メール アドレス。
ステータス
 status string

状態。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
注文
 order integer

順序。
グループ
 group string

グループ。

コンポーネントの削除

操作 ID:
ComponentDelete

ページ上のコンポーネントを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
コンポーネント ID
 component_id True string

コンポーネント識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

コンポーネントの取得

操作 ID:
ComponentGet

ページ上のコンポーネントを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
コンポーネント ID
 component_id True string

コンポーネント識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
Description
 description string

説明。
ステータス
 status string

状態。
一意の電子メール
 uniqueEmail string

一意の電子メール アドレス。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
注文
 order integer

順序。
グループ
 group string

グループ。

コンポーネントの更新

操作 ID:
ComponentPut

ページ上のコンポーネントを更新します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
コンポーネント ID
 component_id True string

コンポーネント識別子。
名前
 name string

名前。
Description
 description string

説明。
ステータス
 status string

状態。
注文
 order integer

順序。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
分類
 grouped boolean

グループ化されているかどうか。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
一意の電子メール
 uniqueEmail string

一意の電子メール アドレス。
ステータス
 status string

状態。
Description
 description string

説明。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
注文
 order integer

順序。
グループ
 group string

グループ。

サブスクライバーの削除

操作 ID:
SubscriberDelete

ページからサブスクライバーを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
サブスクライバー ID
 subscriber_id True string

サブスクライバー ID。

戻り値

response
string

サブスクライバーの追加

操作 ID:
SubscriberPost

ページにサブスクライバーを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
Email
 email string

電子メール アドレス。
All
 all boolean

すべてかどうか。
自動確認
 autoConfirm boolean

自動確認するかどうか。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
Email
 email string

電子メール アドレス。
ID
 site.id string

識別子。
名前
 site.name string

名前。
ロゴ URL
 site.logoUrl string

ロゴの URL アドレス。
サブドメイン
 site.subdomain string

サブドメイン。
パブリック メール
 site.publicEmail string

パブリック メール アドレス。
Language
 site.language string

言語。

サブスクライバーを取得する

操作 ID:
SubscribersGet

ページのサブスクライバーの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
Email
 email string

電子メール アドレス。
電話
 phone string

電話番号。
Webhook
 webhook string

Webhook。
Webhook 電子メール
 webhookEmail string

webhook メール アドレス。
確認済み
 confirmed boolean

確認済みかどうか。
All
 all boolean

すべてかどうか。
Components
 components array of string

コンポーネント。

チーム メンバーの削除

操作 ID:
TeamMemberDelete

ページからチーム メンバーを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンバー ID
 member_id True string

メンバー識別子。

戻り値

response
string

チーム メンバーの追加

操作 ID:
TeamMemberPost

ページでチームにメンバーを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
Email
 email string

電子メール アドレス。

戻り値

response
string

チームメイトを獲得する

操作 ID:
TeammatesGet

チームメイトのリストを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
ID
 user.id string

識別子。
名前
 user.name string

名前。
Email
 user.email string

電子メール アドレス。
アバター
 user.avatar string

アバター。

テンプレートの削除

操作 ID:
TemplateDelete

ページのテンプレートを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
テンプレート識別子
 template_id True string

テンプレート識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
Created At
 createdAt string

作成時に指定します。
ID
 site.id string

識別子。

テンプレートの更新

操作 ID:
TemplatePut

ページのテンプレートを更新します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
テンプレート識別子
 template_id True string

テンプレート識別子。
タイプ
 type string

型。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
タイプ
 type string

型。
名前
 name string

名前。
名前変換 ID
 nameTranslationId string

名前変換識別子。
メッセージ
 message string

メッセージ。
メッセージ変換 ID
 messageTranslationId string

メッセージ変換識別子。
メッセージ HTML
 messageHtml string

メッセージ HTML。
メッセージ HTML 翻訳 ID
 messageHtmlTranslationId string

メッセージ HTML 変換識別子。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
Created At
 createdAt string

作成時に指定します。
サイト ID
 siteId string

サイト識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

状態ページからインポートするかどうか。
削除日
 deletedAt string

削除日時:
Components
 components array of object
ID
 components.id string

識別子。
ステータス
 components.status string

状態。
コンポーネント ID
 components.componentId string

コンポーネント識別子。
テンプレート識別子
 components.templateId string

テンプレート識別子。
[状態からインポート] ページ
 components.importedFromStatuspage boolean

状態ページからインポートするかどうか。
名前
 translations.name string

名前。
メッセージ
 translations.message string

メッセージ。

テンプレートの追加

操作 ID:
TemplatePost

ページのテンプレートを作成します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
サブドメイン
 subdomain string

サブドメイン。
タイプ
 type string

型。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
タイプ
 type string

型。
名前
 name string

名前。
名前変換 ID
 nameTranslationId string

名前変換識別子。
メッセージ
 message string

メッセージ。
メッセージ変換 ID
 messageTranslationId string

メッセージ変換識別子。
メッセージ HTML
 messageHtml string

メッセージ HTML。
メッセージ HTML 翻訳 ID
 messageHtmlTranslationId string

メッセージ HTML 変換識別子。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
Created At
 createdAt string

作成時に指定します。
サイト ID
 siteId string

サイト識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

状態ページからインポートするかどうか。
削除日
 deletedAt string

削除日時:
Components
 components array of string

コンポーネント。
名前
 translations.name string

名前。
メッセージ
 translations.message string

メッセージ。

テンプレートを使用してインシデントを解決する

操作 ID:
IncidentUpdateTemplatePost

テンプレートを使用してページ上のインシデントを解決します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
インシデント ID
 incident_id True string

インシデント識別子。
Template
 template True string

テンプレート。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ変換 ID
 messageTranslationId string

メッセージ変換識別子。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
Started
 started string

起動時。
Ended
 ended string

終了したとき。
期間
 duration string

期間。
Created At
 createdAt string

作成時に指定します。
更新日時
 updatedAt string

更新日時:
インシデント ID
 incidentId string

インシデント識別子。
メッセージ HTML
 messageHtml string

メッセージ HTML。
メッセージ HTML 翻訳 ID
 messageHtmlTranslationId string

メッセージ HTML 変換識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

かどうか。

テンプレートを使用してインシデントを追加する

操作 ID:
IncidentTemplatePost

テンプレートを使用してページにインシデントを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
Template
 template True string

テンプレート。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
名前変換 ID
 nameTranslationId string

名前変換識別子。
Notify
 notify boolean

通知するかどうか。
ステータス
 status string

状態。
Started
 started string

起動時。
解決済み
 resolved string

解決された場合。
期間
 duration string

期間。
Created At
 createdAt string

作成時に指定します。
更新日時
 updatedAt string

更新日時:
自動
 automated boolean

自動化されているかどうか。
インパクト
 impact string

影響。
アプリ ID
 appId string

アプリ識別子。
サイト ID
 siteId string

サイト識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

状態ページからインポートするかどうか。

テンプレートを取得する

操作 ID:
TemplateGet

ページのテンプレートを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
テンプレート識別子
 template_id True string

テンプレート識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
タイプ
 type string

型。
名前
 name string

名前。
名前変換 ID
 nameTranslationId string

名前変換識別子。
メッセージ
 message string

メッセージ。
メッセージ変換 ID
 messageTranslationId string

メッセージ変換識別子。
メッセージ HTML
 messageHtml string

メッセージ HTML。
メッセージ HTML 翻訳 ID
 messageHtmlTranslationId string

メッセージ HTML 変換識別子。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
Created At
 createdAt string

作成時に指定します。
サイト ID
 siteId string

サイト識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

状態ページからインポートするかどうか。
削除日
 deletedAt string

削除日時:
Components
 components array of string

コンポーネント。
名前
 translations.name string

名前。
メッセージ
 translations.message string

メッセージ。

ページ インシデントを取得する

操作 ID:
IncidentsGet

ページのすべてのインシデントを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ステータス
 status string

状態。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
名前
 name string

名前。
Started
 started string

起動時。
ステータス
 status string

状態。
解決済み
 resolved string

解決された場合。
最新情報
 updates array of object
ID
 updates.id string

識別子。
メッセージ
 updates.message string

メッセージ。
メッセージ HTML
 updates.messageHtml string

メッセージ HTML。
ステータス
 updates.status string

状態。
Notify
 updates.notify boolean

通知するかどうか。
Started
 updates.started string

起動時。
Ended
 updates.ended string

終了したとき。
期間
 updates.duration string

期間。
Created At
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

ページ テンプレートを取得する

操作 ID:
PageTemplatesGet

すべてのページ テンプレートの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
タイプ
 type string

型。
名前
 name string

名前。
名前変換 ID
 nameTranslationId string

名前変換識別子。
メッセージ
 message string

メッセージ。
メッセージ変換 ID
 messageTranslationId string

メッセージ変換識別子。
メッセージ HTML
 messageHtml string

メッセージ HTML。
メッセージ Html 翻訳 ID
 messageHtmlTranslationId string

メッセージ HTML 変換識別子。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか.
Created At
 createdAt string

作成時に指定します。
サイト ID
 siteId string

サイト識別子。
[状態からインポート] ページ
 importedFromStatuspage boolean

状態ページからインポートするかどうか。
削除日
 deletedAt string

削除日時:
Components
 components array of object
ID
 components.id string

識別子。
ステータス
 components.status string

状態。
コンポーネント ID
 components.componentId string

コンポーネント識別子。
テンプレート識別子
 components.templateId string

テンプレート識別子。
[状態からインポート] ページ
 components.importedFromStatuspage boolean

状態ページからインポートするかどうか。
名前
 translations.name string

名前。
メッセージ
 translations.message string

メッセージ。

ページのメンテナンスを取得する

操作 ID:
MaintenancesGet

ページのすべてのメンテナンスを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
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

識別子。
メッセージ
 updates.message string

メッセージ。
メッセージ HTML
 updates.messageHtml string

メッセージ HTML。
ステータス
 updates.status string

状態。
Notify
 updates.notify boolean

通知するかどうか。
Started
 updates.started string

起動時。
Ended
 updates.ended string

終了したとき。
期間
 updates.duration string

期間。
Created At
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

メンテナンスの削除

操作 ID:
MaintenanceDelete

ページのメンテナンスを削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

メンテナンスの追加

操作 ID:
MaintenancePost

ページにメンテナンスを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
[開始]
 start string

開始。
End
 end string

最後です。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
期間
 duration integer

期間。
通知の開始
 notifyStart boolean

開始を通知するかどうか。
通知の終了
 notifyEnd boolean

終了を通知するかどうか。
早期に通知する
 notifyEarly boolean

早期に通知するかどうか。
通知の時間 (分)
 notifyMinutes integer

通知の分数。
自動開始
 autoStart boolean

自動開始するかどうかを指定します。
自動終了
 autoEnd boolean

自動終了するかどうかを指定します。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
期間
 duration string

期間。
[開始]
 start string

開始。
End
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

メンテナンスを取得する

操作 ID:
MaintenanceGet

ページのメンテナンスを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。

戻り値

名前 パス 型 説明
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

識別子。
メッセージ
 updates.message string

メッセージ。
メッセージ HTML
 updates.messageHtml string

メッセージ HTML。
ステータス
 updates.status string

状態。
Notify
 updates.notify boolean

通知するかどうか。
Started
 updates.started string

起動時。
Ended
 updates.ended string

終了したとき。
期間
 updates.duration string

期間。
Created At
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

メンテナンス更新プログラムの削除

操作 ID:
MaintenanceUpdateDelete

ページのメンテナンスに対する更新を削除します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。
メンテナンス更新プログラム ID
 maintenance_update_id True string

メンテナンス更新プログラムの識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。

メンテナンス更新プログラムの編集

操作 ID:
MaintenanceUpdatePut

ページのメンテナンスの更新を編集します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。
メンテナンス更新プログラム ID
 maintenance_update_id True string

メンテナンス更新プログラムの識別子。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
End
 end string

最後です。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
Notify
 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

名前。
サブドメイン
 maintenance.components.site.subdomain string

サブドメイン。
色
 maintenance.components.site.color string

色。
ロゴ URL
 maintenance.components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 maintenance.components.site.publicEmail string

パブリック メール アドレス。
Subscribers
 maintenance.components.site.subscribers array of string

サブスクライバー。

メンテナンス更新プログラムを取得する

操作 ID:
MaintenanceUpdateGet

ページのメンテナンスの更新プログラムを取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。
メンテナンス更新プログラム ID
 maintenance_update_id True string

メンテナンス更新プログラムの識別子。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
Notify
 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

名前。
サブドメイン
 maintenance.components.site.subdomain string

サブドメイン。
色
 maintenance.components.site.color string

色。
ロゴ URL
 maintenance.components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 maintenance.components.site.publicEmail string

パブリック メール アドレス。

メンテナンス更新プログラムを追加する

操作 ID:
MaintenanceUpdatePost

ページのメンテナンスに更新プログラムを追加します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
Started
 started string

起動時。
End
 end string

最後です。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
メッセージ
 message string

メッセージ。
メッセージ HTML
 messageHtml string

メッセージ HTML。
Notify
 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

名前。
サブドメイン
 maintenance.components.site.subdomain string

サブドメイン。
色
 maintenance.components.site.color string

色。
ロゴ URL
 maintenance.components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 maintenance.components.site.publicEmail string

パブリック メール アドレス。
Subscribers
 maintenance.components.site.subscribers array of string

サブスクライバー。

更新プログラムのメンテナンス

操作 ID:
MaintenancePut

ページのメンテナンスを更新します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
メンテナンス ID
 maintenance_id True string

メンテナンス識別子。
名前
 name string

名前。
メッセージ
 message string

メッセージ。
Components
 components array of string

コンポーネント。
[開始]
 start string

開始。
End
 end string

最後です。
ステータス
 status string

状態。
Notify
 notify boolean

通知するかどうか。
ID
 id string

識別子。
ステータス
 status string

状態。

戻り値

名前 パス 型 説明
ID
 id string

識別子。
名前
 name string

名前。
ステータス
 status string

状態。
[開始]
 start string

開始。
期間
 duration string

期間。
最新情報
 updates array of object
ID
 updates.id string

識別子。
メッセージ
 updates.message string

メッセージ。
メッセージ HTML
 updates.messageHtml string

メッセージ HTML。
ステータス
 updates.status string

状態。
Notify
 updates.notify boolean

通知するかどうか。
Started
 updates.started string

起動時。
Ended
 updates.ended string

終了したとき。
期間
 updates.duration string

期間。
Created At
 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

名前。
サブドメイン
 components.site.subdomain string

サブドメイン。
色
 components.site.color string

色。
ロゴ URL
 components.site.logoUrl string

ロゴの URL アドレス。
パブリック メール
 components.site.publicEmail string

パブリック メール アドレス。

状態ページのコンポーネントを取得する

操作 ID:
ComponentsGet

すべてのステータス ページ コンポーネントの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
ページ ID
 page_id True string

ページ識別子。
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
名前
 name string

名前。
ステータス
 status string

状態。
一意の電子メール
 uniqueEmail string

一意の電子メール アドレス。
Description
 description string

説明。
アップタイムの表示
 showUptime boolean

アップタイムを表示するかどうか。
注文
 order integer

順序。
グループ
 group string

グループ。

状態ページを取得する

操作 ID:
PagesGet

状態ページの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
ページ
 page integer

ページ。
ページあたりの数
 per_page integer

ページあたりの数。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
サブドメイン
 subdomain string

サブドメイン。
名前
 name string

名前。
ロゴ URL
 logoUrl string

ロゴの URL アドレス。
Favicon URL
 faviconUrl string

favicon URL アドレス。
Web サイトの URL
 websiteUrl string

Web サイトの URL アドレス。
Custom Domain
 customDomain string

カスタム ドメイン。
パブリック メール
 publicEmail string

パブリック メール。
ツイッター
 twitter string

Twitter ハンドル。
ステータス
 status string

状態。
SMS でサブスクライブする
 subscribeBySms boolean

SMS によるサブスクライブが有効かどうか。
Language
 language string

言語。
大きなヘッダーを使用する
 useLargeHeader boolean

大きなヘッダーを使用するかどうか。
ブランドの色
 brandColor string

ブランドの色。
OK の色
 okColor string

OK の色。
中断された色
 disruptedColor string

中断された色。
低下した色
 degradedColor string

低下した色。
下の色
 downColor string

下の色。
色に注目する
 noticeColor string

通知の色。
不明な色
 unknownColor string

不明な色。
Google アナリティクス
 googleAnalytics string

Google アナリティクス。
SMS サービス
 smsService string

SMS サービス。
メタ内の HTML
 htmlInMeta string

メタ内の 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

オンボード済み。
Created At
 createdAt string

作成時に指定します。
更新日時
 updatedAt string

更新日時:

定義

文字列

これは基本的なデータ型 'string' です。