ステータスページ

すべて取得

エンドポイント

GET https://uptime4.com/api/status-pages/

例

curl --request GET \
--url 'https://uptime4.com/api/status-pages/' \
--header 'Authorization: Bearer {api_key}' \

パラメータ	詳細	説明
search	オプション文字列	検索文字列。
search_by	オプション文字列	どのフィールドで検索していますか。許可される値は次のとおりです: `name`.
is_enabled	オプションブール値
project_id	オプション整数
domain_id	オプション整数
datetime_field	オプション文字列	許可される値: `datetime`, `last_datetime`
datetime_start	オプション文字列	Filter results starting from this datetime. `Y-m-d H:i:s` format.
datetime_end	オプション文字列	Filter results up to this datetime. `Y-m-d H:i:s` format.
order_by	オプション文字列	結果を並べ替えるフィールド。許可される値は次のとおりです: `status_page_id`, `datetime`, `last_datetime`, `name`, `pageviews`.
order_type	オプション文字列	結果の順序。許可される値は、昇順の場合は `ASC`、降順の場合は `DESC` です。
page	オプション整数	結果を取得するページ番号。デフォルトは `1` です。
results_per_page	オプション整数	ページごとに必要な結果の数。許可される値は次のとおりです: `10`, `25`, `50`, `100`, `250`, `500`, `1000`。デフォルトは `25` です。

応答例

{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "domain_id": 0,
            "monitors_ids": [1,2,3],
            "project_id": 0,
            "url": "example",
            "full_url": "https://uptime4.com/example/",
            "name": "Example",
            "description": "This is just a simple description for the example status page 👋.",
            "socials": {
                "facebook": "example",
                "instagram": "example",
                "twitter": "example",
                "email": "",
                "website": "https://example.com/"
            },
            "logo_url": "",
            "favicon_url": "",
            "opengraph_url": "",
            "password": false,
            "timezone": "UTC",
            "custom_js": "",
            "custom_css": "",
            "pageviews": 50,
            "is_se_visible": true,
            "is_removed_branding": false,
            "is_enabled": true,
            "datetime": "2026-08-26 14:08:51",
            "last_datetime": "2026-08-26 14:08:51"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptime4.com/api/status-pages?page=1",
        "last": "https://uptime4.com/api/status-pages?page=1",
        "next": null,
        "prev": null,
        "self": "https://uptime4.com/api/status-pages?page=1"
    }
}

1 つ取得

エンドポイント

GET https://uptime4.com/api/status-pages/{status_page_id}

例

curl --request GET \
--url 'https://uptime4.com/api/status-pages/{status_page_id}' \
--header 'Authorization: Bearer {api_key}' \

応答例

{
    "data": {
        "id": 1,
        "user_id": 1,
        "domain_id": 0,
        "monitors_ids": [1,2,3],
        "project_id": 0,
        "url": "example",
        "full_url": "https://uptime4.com/example/",
        "name": "Example",
        "description": "This is just a simple description for the example status page 👋.",
        "socials": {
            "facebook": "example",
            "instagram": "example",
            "twitter": "example",
            "email": "",
            "website": "https://example.com/"
        },
        "logo_url": "",
        "favicon_url": "",
        "opengraph_url": "",
        "password": false,
        "timezone": "UTC",
        "custom_js": "",
        "custom_css": "",
        "pageviews": 50,
        "is_se_visible": true,
        "is_removed_branding": false,
        "is_enabled": true,
        "datetime": "2026-08-26 14:08:51",
        "last_datetime": "2026-08-26 14:08:51"
    }
}

パラメータ	詳細	説明
name	必須文字列	-
description	オプション文字列	-
url	オプション文字列	-
domain_id	オプション整数	-
is_main_status_page	オプションブール値	-
monitors_ids	オプション配列	-
heartbeats_ids	オプション配列	-

curl --request POST \
--url 'https://uptime4.com/api/status-pages' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'description=This is just a simple description.' \
--form 'monitors_ids[]=1' \
--form 'heartbeats_ids[]=1' \

応答例

{
    "data": {
        "id": 1
    }
}

更新

エンドポイント

POST https://uptime4.com/api/status-pages/{status_page_id}

パラメータ	詳細	説明
name	オプション文字列	-
description	オプション文字列	-
url	オプション文字列	-
timezone	オプション文字列	-
password	オプション文字列	-
title	オプション文字列	-
meta_description	オプション文字列	-
meta_keywords	オプション文字列	-
language_code	オプション文字列	-
font_family	オプション文字列	-
theme	オプション文字列	-
custom_css	オプション文字列	-
custom_js	オプション文字列	-
domain_id	オプション整数	-
is_main_status_page	オプションブール値	-
project_id	オプション整数	-
font_size	オプション整数	-
auto_refresh	オプション整数	-
pwa_display_install_bar_delay	オプション整数	-
monitors_ids	オプション配列	-
heartbeats_ids	オプション配列	-
socials	オプション配列	許可される値: `socials[facebook]`, `socials[instagram]`, `socials[x]`, `socials[threads]`, `socials[email]`, `socials[website]`
is_enabled	オプションブール値	-
is_se_visible	オプションブール値	-
is_removed_branding	オプションブール値	-
display_share_buttons	オプションブール値	-
display_header_text	オプションブール値	-
pwa_is_enabled	オプションブール値	-
pwa_display_install_bar	オプションブール値	-
logo	オプションファイル	-
logo_remove	オプションブール値	-
favicon	オプションファイル	-
favicon_remove	オプションブール値	-
opengraph	オプションファイル	-
opengraph_remove	オプションブール値	-
pwa_icon	オプションファイル	-
pwa_icon_remove	オプションブール値	-
pwa_theme_color	オプション文字列	-

例

curl --request POST \
--url 'https://uptime4.com/api/status-pages/{status_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=1' \

応答例

{
    "data": {
        "id": 1
    }
}

削除

エンドポイント

DELETE https://uptime4.com/api/status-pages/{status_page_id}

例

curl --request DELETE \
--url 'https://uptime4.com/api/status-pages/{status_page_id}' \
--header 'Authorization: Bearer {api_key}' \

応答例

{
    "data": {
        "id": 1,
        "user_id": 1,
        "domain_id": 0,
        "monitors_ids": [1,2,3],
        "heartbeats_ids": [1,2,3],
        "project_id": 0,
        "url": "example",
        "full_url": "https://uptime4.com/example/",
        "name": "Example",
        "description": "This is just a simple description for the example status page 👋.",
        "settings": {
            "title": "Example",
            "meta_description": "",
            "meta_keywords": "",
            "language_code": "en",
            "font_family": "default",
            "font_size": 16,
            "display_share_buttons": true,
            "display_header_text": true,
            "auto_refresh": 0,
            "pwa_file_name": null,
            "pwa_is_enabled": false,
            "pwa_icon": null,
            "pwa_display_install_bar": false,
            "pwa_display_install_bar_delay": 3,
            "pwa_theme_color": "#000000"
        },
        "socials": {
            "facebook": "",
            "instagram": "",
            "x": "",
            "threads": "",
            "email": "",
            "website": ""
        },
        "logo_url": null,
        "favicon_url": null,
        "opengraph_url": null,
        "password": false,
        "timezone": "UTC",
        "custom_js": "",
        "custom_css": "",
        "pageviews": 0,
        "is_se_visible": true,
        "is_removed_branding": false,
        "is_enabled": true,
        "datetime": "2026-08-26 14:08:51",
        "last_datetime": "2026-08-26 14:08:51"
    }
}

ステータスページ

すべて取得

1 つ取得

作成

更新

削除