Pages
Add Page
Request
POST /pages
Parameter
Name | Type | Description |
---|
name | string | Required -- Page Name |
title | string | Title of Pages for Status Page (Optional) |
slug | string | Required -- Page Slug |
customDomain | string | Custom Domain |
useGroups | bool | If the uuids of the items belong to groups, this field is true |
items | string[] | Uuids of Monitors or Groups |
description | string | Page Description |
logoFileBase64 | string | Custom Logo in base64 format |
faviconFileBase64 | string | Custom Favicon in base64 format |
googleAnalitycsId | string | Google Analitycs ID |
Request Payload Example
{
"name": "Example Site",
"title": "Title for Example Site",
"slug": "example",
"customDomain": "status.example.com",
"useGroups":true,
"items": [ "4e0b948c-d558-466f-96f9-6758a2a7b23b", "3a46479a-7b6e-4c60-83b8-3769a22fa81f" ],
"description": "Page Description",
"logoFileBase64": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV...",
"faviconFileBase64": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV...",
"googleAnalitycsId": "GoogleAnalitycsID"
}
Request Curl Example
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer d3d6763224e8f54ee5aeb08202b7eb101d97081876819cb48833d9f892185917" \
-d \
'{
"name":"Example Site",
"title":"Title for Example Site",
"slug":"example",
"customDomain":"status.example.com",
"useGroups":true,
"items":["4e0b948c-d558-466f-96f9-6758a2a7b23b", "3a46479a-7b6e-4c60-83b8-3769a22fa81f"],
"description":"Page Description",
"logoFileBase64":
"iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV...",
"faviconFileBase64":
"iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV...",
"googleAnalitycsId":"GoogleAnalyticsId"
}' \
"https://api.statsignal.dev/v1/pages"
Response Example
Status: 201 Created
{
"pages": [
{
"uuid": "6cd3f796-eec0-4891-9892-9dcf19421443",
"name": "Example Site",
"title": "Title for Example Site",
"slug": "example",
"customDomain": "status.example.com",
"useGroups":true,
"items": [
"4e0b948c-d558-466f-96f9-6758a2a7b23b",
"3a46479a-7b6e-4c60-83b8-3769a22fa81f"
],
"description": "Page Description",
"logoUrl": "https://statsignal-public-production.s3-us-west-1.amazonaws.com/pages/logos/d8f88bd1-b0ab-475d-a92b-258c5ed2b0d7.png",
"faviconUrl": "https://statsignal-public-production.s3-us-west-1.amazonaws.com/pages/favicons/d8f88bd1-b0ab-475d-a92b-258c5ed2b0d7.png",
"customDomainState": "ready",
"googleAnalitycsId": "GoogleAnalitycsID",
"createdAt":"2021-05-13T17:32:49.117457Z"
}
]
}