Status Page Announcement
Get Status Page Announcement
Endpoint to retrieve a single Status Page Announcement by ID
post/status-page-announcement/{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 Announcement to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"title": 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",
"statusPages": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"monitors": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"title": "Scheduled Maintenance - Database Upgrade",
"showAnnouncementAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"endAnnouncementAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"description": "# Heading\n\nThis is **markdown** content",
"attachments": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"subscriberNotificationStatus": "Skipped",
"subscriberNotificationStatusMessage": "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.",
"subscriberNotificationStatusOnAnnouncementUpdated": "Skipped",
"subscriberNotificationStatusMessageOnAnnouncementUpdated": "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.",
"shouldStatusPageSubscribersBeNotified": true,
"isOwnerNotified": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.