Status Page
Update Status Page
Endpoint to update an existing Status Page
put/status-page/{id}
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 update
Request body
Example request
{
"data": {
"name": "Example Text",
"isArchived": true,
"requireSsoForLogin": true,
"showIncidentHistoryInDays": 42,
"showAnnouncementHistoryInDays": 42,
"showScheduledEventHistoryInDays": 42
}
}Response
Updated successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"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"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Example Text",
"pageTitle": "Example Text",
"pageDescription": "This is an example of longer text content that provides detailed information.",
"enableSearchEngineIndexing": true,
"description": "This is an example of longer text content that provides detailed information.",
"slug": "example-slug",
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"labels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"archivedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"faviconFile": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"faviconFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"logoFile": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"logoFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"darkThemeLogoFile": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"darkThemeLogoFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"coverImageFile": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"coverImageFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"headerHTML": null,
"footerHTML": null,
"customCSS": null,
"customJavaScript": null,
"isPublicStatusPage": true,
"enableMcpServer": true,
"enableMasterPassword": true,
"masterPassword": "hashed_value_here",
"showIncidentLabelsOnStatusPage": true,
"showScheduledEventLabelsOnStatusPage": true,
"enableEmailSubscribers": true,
"allowSubscribersToChooseResources": true,
"allowSubscribersToChooseEventTypes": true,
"enableSmsSubscribers": true,
"enableSlackSubscribers": true,
"enableMicrosoftTeamsSubscribers": true,
"enableWebhookSubscribers": true,
"sendSubscriberNotifications": true,
"limitSubscribersToPrivateUsers": true,
"allowedSubscriberEmailDomains": "This is an example of longer text content that provides detailed information.",
"copyrightText": "Example Text",
"logoAltText": "Example Text",
"coverImageAltText": "Example Text",
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"requireSsoForLogin": true,
"enableMagicLinkLogin": true,
"privateUserSessionLengthInHours": 42,
"smtpConfig": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"smtpConfigId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"callSmsConfig": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"callSmsConfigId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"showIncidentHistoryInDays": 42,
"showAnnouncementHistoryInDays": 42,
"showScheduledEventHistoryInDays": 42,
"overviewPageDescription": null,
"hidePoweredByOneUptimeBranding": true,
"defaultBarColor": "#FF0000",
"theme": "Example Text",
"downtimeMonitorStatuses": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"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": "Example Text",
"reportTimezone": "Example Text",
"showOverallUptimePercentOnStatusPage": true,
"overallUptimePercentPrecision": "Example Text",
"subscriberEmailNotificationFooterText": "This is an example of longer text content that provides detailed information.",
"enableCustomSubscriberEmailNotificationFooterText": true,
"showIncidentsOnStatusPage": true,
"onlyShowScopedIncidents": true,
"showAnnouncementsOnStatusPage": true,
"showEpisodesOnStatusPage": true,
"showEpisodeHistoryInDays": 42,
"showEpisodeLabelsOnStatusPage": true,
"showScheduledMaintenanceEventsOnStatusPage": true,
"showSubscriberPageOnStatusPage": true,
"ipWhitelist": "This is an example of longer text content that provides detailed information.",
"enableEmbeddedOverallStatus": true,
"showUptimeHistoryInDays": 42,
"embeddedOverallStatusToken": "Example Text",
"defaultLanguage": "Example Text",
"enabledLanguages": {
"key": "value",
"nested": {
"data": 123
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.