Incident Episode
Create Incident Episode
Endpoint to create a new Incident Episode
post/incident-episode
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"data": {
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"title": "This is an example of longer text content that provides detailed information."
}
}Response
Created 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,
"episodeNumber": 42,
"episodeNumberWithPrefix": "Example Text",
"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",
"rootCause": null,
"lastIncidentAddedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"resolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"allIncidentsResolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"firstPagedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"assignedToUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"assignedToUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"assignedToTeam": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"assignedToTeamId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"onCallDutyPolicies": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"isOnCallPolicyExecuted": true,
"incidentCount": 42,
"titleTemplate": "This is an example of longer text content that provides detailed information.",
"descriptionTemplate": "This is an example of longer text content that provides detailed information.",
"isManuallyCreated": true,
"labels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"isOwnerNotifiedOfEpisodeCreation": true,
"groupingKey": "This is an example of longer text content that provides detailed information.",
"incidentGroupingRule": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"incidentGroupingRuleId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"remediationNotes": null,
"postmortemNote": null,
"postUpdatesToWorkspaceChannels": {
"key": "value",
"nested": {
"data": 123
}
},
"isVisibleOnStatusPage": true,
"declaredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"shouldStatusPageSubscribersBeNotifiedOnEpisodeCreated": true,
"subscriberNotificationStatusMessage": "This is an example of longer text content that provides detailed information.",
"isPrivate": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.