Status Page
Get Status Page
Endpoint to retrieve a single Status Page by ID
post/status-page/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Status Page to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"pageTitle": true,
"copyrightText": true,
"logoAltText": true,
"coverImageAltText": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Corp Status Page",
"pageTitle": "Acme Corp System Status",
"pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
"enableSearchEngineIndexing": true,
"description": "Public status page for Acme Corp customer-facing services",
"slug": "example-slug-value",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"faviconFileId": "123e4567-e89b-12d3-a456-426614174000",
"logoFileId": "123e4567-e89b-12d3-a456-426614174000",
"darkThemeLogoFileId": "123e4567-e89b-12d3-a456-426614174000",
"coverImageFileId": "123e4567-e89b-12d3-a456-426614174000",
"headerHTML": "<div><h1>Title</h1><p>Content</p></div>",
"footerHTML": "<div><h1>Title</h1><p>Content</p></div>",
"customCSS": "body { color: #333; margin: 0; }",
"customJavaScript": "function example() { return true; }",
"isPublicStatusPage": true,
"enableMcpServer": true,
"enableMasterPassword": true,
"masterPassword": "hashed_string_value",
"showIncidentLabelsOnStatusPage": true,
"showScheduledEventLabelsOnStatusPage": true,
"enableEmailSubscribers": true,
"allowSubscribersToChooseResources": true,
"allowSubscribersToChooseEventTypes": true,
"enableSmsSubscribers": true,
"enableSlackSubscribers": true,
"enableMicrosoftTeamsSubscribers": true,
"enableWebhookSubscribers": true,
"sendSubscriberNotifications": true,
"limitSubscribersToPrivateUsers": true,
"allowedSubscriberEmailDomains": "acme.com\nacme.de",
"copyrightText": "Example short text",
"logoAltText": "Example short text",
"coverImageAltText": "Example short text",
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"requireSsoForLogin": true,
"enableMagicLinkLogin": true,
"privateUserSessionLengthInHours": 42,
"smtpConfigId": "123e4567-e89b-12d3-a456-426614174000",
"callSmsConfigId": "123e4567-e89b-12d3-a456-426614174000",
"isOwnerNotifiedOfResourceCreation": true,
"showIncidentHistoryInDays": 42,
"showAnnouncementHistoryInDays": 42,
"showScheduledEventHistoryInDays": 42,
"overviewPageDescription": "# Heading\n\nThis is **markdown** content",
"hidePoweredByOneUptimeBranding": true,
"defaultBarColor": {
"_type": "Color",
"value": "#ff0000"
},
"theme": "Light",
"downtimeMonitorStatuses": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"subscriberTimezones": {
"key": "value",
"nested": {
"data": 123
}
},
"isReportEnabled": true,
"reportStartDateTime": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"reportRecurringInterval": {
"key": "value",
"nested": {
"data": 123
}
},
"sendNextReportBy": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"reportDataInDays": 42,
"reportPeriodType": "Rolling",
"reportTimezone": "Example short text",
"showOverallUptimePercentOnStatusPage": true,
"overallUptimePercentPrecision": "99% (No Decimal)",
"subscriberEmailNotificationFooterText": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"enableCustomSubscriberEmailNotificationFooterText": true,
"showIncidentsOnStatusPage": true,
"onlyShowScopedIncidents": true,
"showAnnouncementsOnStatusPage": true,
"showEpisodesOnStatusPage": true,
"showEpisodeHistoryInDays": 42,
"showEpisodeLabelsOnStatusPage": true,
"showScheduledMaintenanceEventsOnStatusPage": true,
"showSubscriberPageOnStatusPage": true,
"ipWhitelist": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"enableEmbeddedOverallStatus": true,
"showUptimeHistoryInDays": 42,
"embeddedOverallStatusToken": "Example short text",
"defaultLanguage": "Example short text",
"enabledLanguages": {
"key": "value",
"nested": {
"data": 123
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.