Instatus (独立系発行者) (プレビュー)
ダウンタイムへの耐性があり、読み込みが速い状態ページを取得します。 状態ページは静的で、バックエンドから独立して読み込まれます。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://instatus.com/ |
プライバシー ポリシー | https://instatus.com/policies/privacy |
カテゴリー | Web サイト; IT オペレーション |
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
API キー ('Bearer API_Key' 形式) | securestring | この API に対する API キー ('Bearer API_Key' 形式) | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
インシデントの更新 |
ページのインシデントを更新します。 |
インシデントの更新を削除する |
ページ上のインシデントの更新を削除します。 |
インシデントの更新を追加する |
ページ インシデントに更新を追加します。 |
インシデントを削除 |
ページのインシデントを削除します。 |
インシデントを取得する |
ページのインシデントを取得します。 |
インシデントを追加する |
ページにインシデントを追加します。 |
インシデント更新を取得する |
ページの更新を取得します。 |
インシデント更新を編集する |
ページ上のインシデントの更新を編集します。 |
コンポーネントの削除 |
ページのコンポーネントを削除します。 |
コンポーネントの更新 |
ページのコンポーネントを更新します。 |
コンポーネントを作成する |
ページにコンポーネントを作成します。 |
コンポーネントを取得する |
ページのコンポーネントを取得します。 |
サブスクライバーを削除する |
ページからサブスクライバーを削除します。 |
サブスクライバーを取得する |
ページのサブスクライバーの一覧を取得します。 |
サブスクライバーを追加する |
サブスクライバーをページに追加します。 |
チーム メンバーを削除する |
ページからチーム メンバーを削除します。 |
チーム メンバーを追加する |
ページのチームにメンバーを追加します。 |
チームメイトを取得する |
チームメイトの一覧を取得します。 |
テンプレートの削除 |
ページのテンプレートを削除します。 |
テンプレートの取得 |
ページのテンプレートを取得します。 |
テンプレートの追加 |
ページのテンプレートを作成します。 |
テンプレートを使用してインシデントを解決する |
テンプレートを使用してページのインシデントを解決します。 |
テンプレートを使用してインシデントを追加する |
テンプレートを使用してページにインシデントを追加します。 |
テンプレートを更新 |
ページのテンプレートを更新します。 |
ページ インシデントの取得 |
ページのすべてのインシデントを取得します。 |
ページ テンプレートを取得する |
すべてのページ テンプレートの一覧を取得します。 |
ページのメンテナンスを取得する |
ページのすべてのメンテナンスを取得します。 |
メンテナンスの取得 |
ページのメンテナンスを取得します。 |
メンテナンスを削除する |
ページのメンテナンスを削除します。 |
メンテナンスを追加する |
ページにメンテナンスを追加します。 |
メンテナンス更新 |
ページでメンテナンスを更新します。 |
メンテナンス更新を削除する |
ページのメンテナンスに対する更新を削除します。 |
メンテナンス更新を取得する |
ページのメンテナンスに対する更新を取得します。 |
メンテナンス更新を編集する |
ページのメンテナンスに対する更新を編集します。 |
メンテナンス更新を追加する |
ページのメンテナンスに更新を追加します。 |
状態ページのコンポーネントを取得する |
すべての状態ページ コンポーネントの一覧を取得します。 |
状態ページを作成する |
要求されたパラメーターに基づいて、新しい状態ページを作成します。 |
状態ページを削除する |
状態ページを削除します。 |
状態ページを取得する |
状態ページの一覧を取得します。 |
状態ページを更新する |
状態ページの作成を更新する |
インシデントの更新
ページのインシデントを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
件名
|
name | string |
名前。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
開始済み
|
started | string |
開始時。 |
解決
|
resolved | string |
解決されたとき。 |
更新プログラム
|
updates | array of string |
更新。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
インシデントの更新 ID
|
incident_update_id | True | string |
インシデント更新の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
インシデントの更新を追加する
ページ インシデントに更新を追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Status
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
ID
|
incident.id | string |
識別子。 |
件名
|
incident.name | string |
名前。 |
開始済み
|
incident.started | string |
開始時。 |
Status
|
incident.status | string |
状態。 |
コンポーネント
|
incident.components | array of object | |
ID
|
incident.components.id | string |
識別子。 |
件名
|
incident.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
インシデントを取得する
ページのインシデントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
開始済み
|
started | string |
開始時。 |
解決
|
resolved | string |
解決されたとき。 |
更新プログラム
|
updates | array of object | |
ID
|
updates.id | string |
識別子。 |
Message
|
updates.message | string |
メッセージ。 |
メッセージ HTML
|
updates.messageHtml | string |
メッセージ HTML。 |
Status
|
updates.status | string |
状態。 |
Notify
|
updates.notify | boolean |
通知するかどうか。 |
開始済み
|
updates.started | string |
開始時。 |
終了した
|
updates.ended | string |
終了時。 |
長さ
|
updates.duration | string |
期間。 |
作成日
|
updates.createdAt | string |
作成日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
件名
|
name | string |
名前。 |
|
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
開始済み
|
started | string |
開始時。 |
解決
|
resolved | string |
解決されたとき。 |
更新プログラム
|
updates | array of string |
更新。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
インシデントの更新 ID
|
incident_update_id | True | string |
インシデント更新の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Status
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
ID
|
incident.id | string |
識別子。 |
件名
|
incident.name | string |
名前。 |
開始済み
|
incident.started | string |
開始時。 |
Status
|
incident.status | string |
状態。 |
コンポーネント
|
incident.components | array of object | |
ID
|
incident.components.id | string |
識別子。 |
件名
|
incident.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
インシデントの更新 ID
|
incident_update_id | True | string |
インシデント更新の識別子。 |
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Status
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
ID
|
incident.id | string |
識別子。 |
件名
|
incident.name | string |
名前。 |
開始済み
|
incident.started | string |
開始時。 |
Status
|
incident.status | string |
状態。 |
コンポーネント
|
incident.components | array of object | |
ID
|
incident.components.id | string |
識別子。 |
件名
|
incident.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
コンポーネント ID
|
component_id | True | string |
コンポーネントの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
コンポーネントの更新
ページのコンポーネントを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
コンポーネント ID
|
component_id | True | string |
コンポーネントの識別子。 |
件名
|
name | string |
名前。 |
|
Description
|
description | string |
説明設定。 |
|
Status
|
status | string |
状態。 |
|
Order
|
order | integer |
順序。 |
|
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
|
グループ化
|
grouped | boolean |
グループ化されているかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
一意の電子メール
|
uniqueEmail | string |
一意のメール アドレス。 |
Status
|
status | string |
状態。 |
Description
|
description | string |
説明設定。 |
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
order | integer |
順序。 |
Group
|
group | string |
グループです。 |
コンポーネントを作成する
ページにコンポーネントを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
件名
|
name | string |
名前。 |
|
Description
|
description | string |
説明設定。 |
|
Status
|
status | string |
状態。 |
|
Order
|
order | integer |
順序。 |
|
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
|
グループ化
|
grouped | boolean |
グループ化されているかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Description
|
description | string |
説明設定。 |
一意の電子メール
|
uniqueEmail | string |
一意のメール アドレス。 |
Status
|
status | string |
状態。 |
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
order | integer |
順序。 |
Group
|
group | string |
グループです。 |
コンポーネントを取得する
ページのコンポーネントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
コンポーネント ID
|
component_id | True | string |
コンポーネントの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Description
|
description | string |
説明設定。 |
Status
|
status | string |
状態。 |
一意の電子メール
|
uniqueEmail | string |
一意のメール アドレス。 |
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
order | integer |
順序。 |
Group
|
group | string |
グループです。 |
サブスクライバーを削除する
ページからサブスクライバーを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
Subscriber ID
|
subscriber_id | True | string |
サブスクライバー ID。 |
戻り値
- 返答
- string
サブスクライバーを取得する
ページのサブスクライバーの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
メール
|
string |
メール アドレス。 |
|
電話番号
|
phone | string |
電話番号。 |
ウェブフック
|
webhook | string |
Webhook。 |
Webhook メール
|
webhookEmail | string |
Webhook メール アドレス。 |
Confirmed
|
confirmed | boolean |
確認済みかどうか。 |
All
|
all | boolean |
すべてかどうか。 |
コンポーネント
|
components | array of string |
コンポーネント。 |
サブスクライバーを追加する
サブスクライバーをページに追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
メール
|
string |
メール アドレス。 |
||
All
|
all | boolean |
すべてかどうか。 |
|
自動確認
|
autoConfirm | boolean |
自動確認するかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
メール
|
string |
メール アドレス。 |
|
ID
|
site.id | string |
識別子。 |
件名
|
site.name | string |
名前。 |
ロゴ URL
|
site.logoUrl | string |
ロゴ URL アドレス。 |
サブドメイン
|
site.subdomain | string |
サブドメイン。 |
公開メール
|
site.publicEmail | string |
公開メール アドレス。 |
Language
|
site.language | string |
言語。 |
チーム メンバーを削除する
ページからチーム メンバーを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
Member ID
|
member_id | True | string |
メンバーの識別子。 |
戻り値
- 返答
- string
チーム メンバーを追加する
ページのチームにメンバーを追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
メール
|
string |
メール アドレス。 |
戻り値
- 返答
- string
チームメイトを取得する
チームメイトの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
ID
|
user.id | string |
識別子。 |
件名
|
user.name | string |
名前。 |
メール
|
user.email | string |
メール アドレス。 |
アバター
|
user.avatar | string |
アバター。 |
テンプレートの削除
ページのテンプレートを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
テンプレート ID
|
template_id | True | string |
テンプレートの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Message
|
message | string |
メッセージ。 |
作成日
|
createdAt | string |
作成日時。 |
ID
|
site.id | string |
識別子。 |
テンプレートの取得
ページのテンプレートを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
テンプレート ID
|
template_id | True | string |
テンプレートの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
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
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
作成日
|
createdAt | string |
作成日時。 |
サイト ID
|
siteId | string |
サイトの識別子です。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
Deleted At
|
deletedAt | string |
削除日時。 |
コンポーネント
|
components | array of string |
コンポーネント。 |
件名
|
translations.name | string |
名前。 |
Message
|
translations.message | string |
メッセージ。 |
テンプレートの追加
ページのテンプレートを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
サブドメイン
|
subdomain | string |
サブドメイン。 |
|
タイプ
|
type | string |
種類。 |
|
件名
|
name | string |
名前。 |
|
Message
|
message | string |
メッセージ。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
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
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
作成日
|
createdAt | string |
作成日時。 |
サイト ID
|
siteId | string |
サイトの識別子です。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
Deleted At
|
deletedAt | string |
削除日時。 |
コンポーネント
|
components | array of string |
コンポーネント。 |
件名
|
translations.name | string |
名前。 |
Message
|
translations.message | string |
メッセージ。 |
テンプレートを使用してインシデントを解決する
テンプレートを使用してページのインシデントを解決します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
インシデント ID
|
incident_id | True | string |
インシデント識別子。 |
Template
|
template | True | string |
テンプレートです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ翻訳 ID
|
messageTranslationId | string |
メッセージ翻訳識別子。 |
Status
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
終了した
|
ended | string |
終了時。 |
長さ
|
duration | string |
期間。 |
作成日
|
createdAt | string |
作成日時。 |
更新日
|
updatedAt | string |
更新時刻。 |
インシデント ID
|
incidentId | string |
インシデント識別子。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
メッセージ HTML 翻訳 ID
|
messageHtmlTranslationId | string |
メッセージ HTML 翻訳識別子。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
かどうか。 |
テンプレートを使用してインシデントを追加する
テンプレートを使用してページにインシデントを追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
Template
|
template | True | string |
テンプレートです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
名前翻訳 ID
|
nameTranslationId | string |
名前翻訳識別子。 |
Notify
|
notify | boolean |
通知するかどうか。 |
Status
|
status | string |
状態。 |
開始済み
|
started | string |
開始時。 |
解決
|
resolved | string |
解決されたとき。 |
長さ
|
duration | string |
期間。 |
作成日
|
createdAt | string |
作成日時。 |
更新日
|
updatedAt | string |
更新時刻。 |
自動
|
automated | boolean |
自動化されているかどうか。 |
影響
|
impact | string |
影響。 |
App ID
|
appId | string |
アプリの識別子。 |
サイト ID
|
siteId | string |
サイトの識別子です。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
テンプレートを更新
ページのテンプレートを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
テンプレート ID
|
template_id | True | string |
テンプレートの識別子。 |
タイプ
|
type | string |
種類。 |
|
件名
|
name | string |
名前。 |
|
Message
|
message | string |
メッセージ。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
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
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
作成日
|
createdAt | string |
作成日時。 |
サイト ID
|
siteId | string |
サイトの識別子です。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
Deleted At
|
deletedAt | string |
削除日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
Status
|
components.status | string |
状態。 |
コンポーネント ID
|
components.componentId | string |
コンポーネントの識別子。 |
テンプレート ID
|
components.templateId | string |
テンプレートの識別子。 |
状態ページからインポート
|
components.importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
件名
|
translations.name | string |
名前。 |
Message
|
translations.message | string |
メッセージ。 |
ページ インシデントの取得
ページのすべてのインシデントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
Status
|
status | string |
状態。 |
|
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
開始済み
|
started | string |
開始時。 |
Status
|
status | string |
状態。 |
解決
|
resolved | string |
解決されたとき。 |
更新プログラム
|
updates | array of object | |
ID
|
updates.id | string |
識別子。 |
Message
|
updates.message | string |
メッセージ。 |
メッセージ HTML
|
updates.messageHtml | string |
メッセージ HTML。 |
Status
|
updates.status | string |
状態。 |
Notify
|
updates.notify | boolean |
通知するかどうか。 |
開始済み
|
updates.started | string |
開始時。 |
終了した
|
updates.ended | string |
終了時。 |
長さ
|
updates.duration | string |
期間。 |
作成日
|
updates.createdAt | string |
作成日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
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
|
status | string |
状態。 |
Notify
|
notify | boolean |
通知するかどうか。 |
作成日
|
createdAt | string |
作成日時。 |
サイト ID
|
siteId | string |
サイトの識別子です。 |
状態ページからインポート
|
importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
Deleted At
|
deletedAt | string |
削除日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
Status
|
components.status | string |
状態。 |
コンポーネント ID
|
components.componentId | string |
コンポーネントの識別子。 |
テンプレート ID
|
components.templateId | string |
テンプレートの識別子。 |
状態ページからインポート
|
components.importedFromStatuspage | boolean |
状態ページからインポートされたかどうか。 |
件名
|
translations.name | string |
名前。 |
Message
|
translations.message | string |
メッセージ。 |
ページのメンテナンスを取得する
ページのすべてのメンテナンスを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
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。 |
Status
|
updates.status | string |
状態。 |
Notify
|
updates.notify | boolean |
通知するかどうか。 |
開始済み
|
updates.started | string |
開始時。 |
終了した
|
updates.ended | string |
終了時。 |
長さ
|
updates.duration | string |
期間。 |
作成日
|
updates.createdAt | string |
作成日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
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。 |
Status
|
updates.status | string |
状態。 |
Notify
|
updates.notify | boolean |
通知するかどうか。 |
開始済み
|
updates.started | string |
開始時。 |
終了した
|
updates.ended | string |
終了時。 |
長さ
|
updates.duration | string |
期間。 |
作成日
|
updates.createdAt | string |
作成日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
メンテナンスを追加する
ページにメンテナンスを追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
件名
|
name | string |
名前。 |
|
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
先頭
|
start | string |
開始。 |
|
末尾
|
end | string |
終了。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
長さ
|
duration | integer |
期間。 |
|
開始通知
|
notifyStart | boolean |
開始を通知するかどうか。 |
|
終了通知
|
notifyEnd | boolean |
終了を通知するかどうか。 |
|
早期通知
|
notifyEarly | boolean |
早期に通知するかどうか。 |
|
分の通知
|
notifyMinutes | integer |
分の通知。 |
|
自動起動
|
autoStart | boolean |
自動起動するかどうか。 |
|
自動終了
|
autoEnd | boolean |
自動終了するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
長さ
|
duration | string |
期間。 |
先頭
|
start | string |
開始。 |
末尾
|
end | string |
終了。 |
Status
|
status | string |
状態。 |
更新プログラム
|
updates | array of string |
更新。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
件名
|
name | string |
名前。 |
|
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
先頭
|
start | string |
開始。 |
|
末尾
|
end | string |
終了。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
先頭
|
start | string |
開始。 |
長さ
|
duration | string |
期間。 |
更新プログラム
|
updates | array of object | |
ID
|
updates.id | string |
識別子。 |
Message
|
updates.message | string |
メッセージ。 |
メッセージ HTML
|
updates.messageHtml | string |
メッセージ HTML。 |
Status
|
updates.status | string |
状態。 |
Notify
|
updates.notify | boolean |
通知するかどうか。 |
開始済み
|
updates.started | string |
開始時。 |
終了した
|
updates.ended | string |
終了時。 |
長さ
|
updates.duration | string |
期間。 |
作成日
|
updates.createdAt | string |
作成日時。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
メンテナンス更新 ID
|
maintenance_update_id | True | string |
メンテナンス更新識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
メンテナンス更新を取得する
ページのメンテナンスに対する更新を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
メンテナンス更新 ID
|
maintenance_update_id | True | string |
メンテナンス更新識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
Status
|
status | string |
状態。 |
ID
|
maintenance.id | string |
識別子。 |
件名
|
maintenance.name | string |
名前。 |
先頭
|
maintenance.start | string |
開始。 |
Status
|
maintenance.status | string |
状態。 |
コンポーネント
|
maintenance.components | array of object | |
ID
|
maintenance.components.id | string |
識別子。 |
件名
|
maintenance.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
メンテナンス更新 ID
|
maintenance_update_id | True | string |
メンテナンス更新識別子。 |
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
末尾
|
end | string |
終了。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
Status
|
status | string |
状態。 |
ID
|
maintenance.id | string |
識別子。 |
件名
|
maintenance.name | string |
名前。 |
先頭
|
maintenance.start | string |
開始。 |
Status
|
maintenance.status | string |
状態。 |
コンポーネント
|
maintenance.components | array of object | |
ID
|
maintenance.components.id | string |
識別子。 |
件名
|
maintenance.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
メンテナンス ID
|
maintenance_id | True | string |
メンテナンス識別子。 |
Message
|
message | string |
メッセージ。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
開始済み
|
started | string |
開始時。 |
|
末尾
|
end | string |
終了。 |
|
Status
|
status | string |
状態。 |
|
Notify
|
notify | boolean |
通知するかどうか。 |
|
ID
|
id | string |
識別子。 |
|
Status
|
status | string |
状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
Message
|
message | string |
メッセージ。 |
メッセージ HTML
|
messageHtml | string |
メッセージ HTML。 |
Notify
|
notify | boolean |
通知するかどうか。 |
開始済み
|
started | string |
開始時。 |
Status
|
status | string |
状態。 |
ID
|
maintenance.id | string |
識別子。 |
件名
|
maintenance.name | string |
名前。 |
先頭
|
maintenance.start | string |
開始。 |
Status
|
maintenance.status | string |
状態。 |
コンポーネント
|
maintenance.components | array of object | |
ID
|
maintenance.components.id | string |
識別子。 |
件名
|
maintenance.components.name | string |
名前。 |
Status
|
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
|
page_id | True | string |
ページの識別子。 |
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
一意の電子メール
|
uniqueEmail | string |
一意のメール アドレス。 |
Description
|
description | string |
説明設定。 |
稼働時間を表示
|
showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
order | integer |
順序。 |
Group
|
group | string |
グループです。 |
状態ページを作成する
要求されたパラメーターに基づいて、新しい状態ページを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メール
|
string |
メール アドレス。 |
||
件名
|
name | string |
名前。 |
|
サブドメイン
|
subdomain | string |
サブドメイン。 |
|
コンポーネント
|
components | array of string |
コンポーネント。 |
|
ロゴ URL
|
logoUrl | string |
ロゴ URL アドレス。 |
|
ファビコン URL
|
faviconUrl | string |
ファビコン 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 Analytics
|
googleAnalytics | string |
Google Analytics。 |
|
SMS で購読する
|
subscribeBySms | boolean |
SMS で購読するかどうか。 |
|
SMS サービス
|
smsService | string |
SMS サービス。 |
|
Twilio SID
|
twilioSid | string |
Twilio SID。 |
|
Twilio トークン
|
twilioToken | string |
Twilio トークン。 |
|
Twilio 送信者
|
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 |
時刻lの表示形式。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
作成日
|
createdAt | string |
作成日時。 |
サブドメイン
|
subdomain | string |
サブドメイン。 |
ロゴ URL
|
logoUrl | string |
ロゴ URL アドレス。 |
ファビコン URL
|
faviconUrl | string |
ファビコン URL アドレス。 |
Web サイトの URL
|
websiteUrl | string |
Web サイト URL アドレス。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
カラー
|
color | string |
色。 |
Language
|
language | string |
言語。 |
Google Analytics
|
googleAnalytics | string |
Google Analytics。 |
公開メール
|
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 |
時刻lの表示形式。 |
Private
|
private | boolean |
非公開かどうか。 |
許可リストの使用
|
useAllowList | boolean |
許可リストを使用するかどうか。 |
許可リスト
|
allowList | array of string |
許可リスト。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
components.status | string |
状態。 |
稼働時間を表示
|
components.showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
components.order | string |
順序。 |
Group
|
components.group | string |
グループです。 |
インシデント
|
components.incidents | array of string |
インシデント。 |
状態ページを削除する
状態ページを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
状態ページを取得する
状態ページの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ぺージ
|
page | integer |
ページ。 |
|
ページあたりの数
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string |
識別子。 |
サブドメイン
|
subdomain | string |
サブドメイン。 |
件名
|
name | string |
名前。 |
ロゴ URL
|
logoUrl | string |
ロゴ URL アドレス。 |
ファビコン URL
|
faviconUrl | string |
ファビコン URL アドレス。 |
Web サイトの URL
|
websiteUrl | string |
Web サイト URL アドレス。 |
Custom Domain
|
customDomain | string |
カスタム ドメイン。 |
公開メール
|
publicEmail | string |
公開メール。 |
Twitter
|
string |
Twitter ハンドル。 |
|
Status
|
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 Analytics
|
googleAnalytics | string |
Google Analytics。 |
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 |
オンボーディング済み。 |
作成日
|
createdAt | string |
作成日時。 |
更新日
|
updatedAt | string |
更新時刻。 |
状態ページを更新する
状態ページの作成を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ ID
|
page_id | True | string |
ページの識別子。 |
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
Status
|
status | string |
状態。 |
|
サブドメイン
|
subdomain | string |
サブドメイン。 |
|
ロゴ URL
|
logoUrl | string |
ロゴ URL アドレス。 |
|
ファビコン URL
|
faviconUrl | string |
ファビコン 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 Analytics
|
googleAnalytics | string |
Google Analytics。 |
|
SMS で購読する
|
subscribeBySms | boolean |
SMS で購読するかどうか。 |
|
SMS サービス
|
smsService | string |
SMS サービス。 |
|
Twilio SID
|
twilioSid | string |
Twilio SID。 |
|
Twilio トークン
|
twilioToken | string |
Twilio トークン。 |
|
Twilio 送信者
|
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 |
時刻lの表示形式。 |
|
Private
|
private | boolean |
非公開かどうか。 |
|
許可リストの使用
|
useAllowList | boolean |
許可リストを使用するかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
識別子。 |
作成日
|
createdAt | string |
作成日時。 |
サブドメイン
|
subdomain | string |
サブドメイン。 |
件名
|
name | string |
名前。 |
Status
|
status | string |
状態。 |
ロゴ URL
|
logoUrl | string |
ロゴ URL アドレス。 |
ファビコン URL
|
faviconUrl | string |
ファビコン URL アドレス。 |
Web サイトの URL
|
websiteUrl | string |
Web サイト URL アドレス。 |
カラー
|
color | string |
色。 |
Language
|
language | string |
言語。 |
Google Analytics
|
googleAnalytics | string |
Google Analytics。 |
公開メール
|
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 |
時刻lの表示形式。 |
Private
|
private | boolean |
非公開かどうか。 |
許可リストの使用
|
useAllowList | boolean |
許可リストを使用するかどうか。 |
許可リスト
|
allowList | array of |
許可リスト。 |
コンポーネント
|
components | array of object | |
ID
|
components.id | string |
識別子。 |
件名
|
components.name | string |
名前。 |
Status
|
components.status | string |
状態。 |
稼働時間を表示
|
components.showUptime | boolean |
稼働時間を表示するかどうか。 |
Order
|
components.order | string |
順序。 |
Group
|
components.group | string |
グループです。 |
インシデント
|
components.incidents | array of string |
インシデント。 |
定義
string
これは基本的なデータ型 '文字列' です。