Incident
Update Incident
Endpoint to update an existing Incident
put/incident/{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 Incident to update
Request body
Example request
{
"data": {
"title": "This is an example of longer text content that provides detailed information.",
"declaredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"currentIncidentStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"incidentSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}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",
"title": "This is an example of longer text content that provides detailed information.",
"description": null,
"declaredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"impactStartedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"firstPagedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"slug": "example-slug",
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"monitors": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"hosts": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"networkDevices": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"kubernetesClusters": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"kubernetesResources": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"kubernetesContainers": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"dockerHosts": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"podmanHosts": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"proxmoxClusters": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"openStackClouds": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"vmwareVCenters": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"iotFleets": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"dockerSwarmClusters": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"cephClusters": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"storageArrays": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"cloudResources": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"databaseServers": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"dockerResources": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"podmanResources": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"services": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"serviceLevelObjectives": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"onCallDutyPolicies": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"labels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"currentIncidentState": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"currentIncidentStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"incidentSeverity": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"incidentSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"changeMonitorStatusTo": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"changeMonitorStatusToId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"subscriberNotificationStatusMessage": "This is an example of longer text content that provides detailed information.",
"subscriberNotificationStatusMessageOnPostmortemPublished": "This is an example of longer text content that provides detailed information.",
"shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": true,
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"rootCause": null,
"postmortemNote": null,
"showPostmortemOnStatusPage": true,
"notifySubscribersOnPostmortemPublished": true,
"postmortemPostedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"postmortemAttachments": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"postmortemStatus": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"postmortemStatusId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdStateLog": {
"key": "value",
"nested": {
"data": 123
}
},
"createdCriteriaId": "This is an example of longer text content that provides detailed information.",
"createdIncidentTemplateId": "This is an example of longer text content that provides detailed information.",
"seriesFingerprint": "This is an example of longer text content that provides detailed information.",
"seriesLabels": {
"key": "value",
"nested": {
"data": 123
}
},
"monitorSummary": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByProbe": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByProbeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"isCreatedAutomatically": true,
"holdsMonitors": true,
"postmortemDraftWaitingSince": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"remediationNotes": null,
"telemetryQuery": {
"key": "value",
"nested": {
"data": 123
}
},
"incidentNumber": 42,
"incidentNumberWithPrefix": "Example Text",
"isVisibleOnStatusPage": true,
"statusPages": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"isPrivate": true,
"enableReminders": true,
"nextReminderNotificationAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"reminderNotificationSentCount": 42,
"incidentEpisode": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"incidentEpisodeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.