Incident
List Incident
Endpoint to list all Incident items
post/incident/get-list
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
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"title": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"incidentNumberWithPrefix": true
},
"sort": {
"createdAt": "DESC"
}
}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",
"title": "Database connection failure in production",
"description": "# Heading\n\nThis is **markdown** content",
"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-value",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"monitors": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"hosts": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"networkDevices": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"kubernetesClusters": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"kubernetesResources": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"kubernetesContainers": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"dockerHosts": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"podmanHosts": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"proxmoxClusters": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"openStackClouds": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"vmwareVCenters": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"iotFleets": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"dockerSwarmClusters": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"cephClusters": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"storageArrays": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"cloudResources": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"databaseServers": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"dockerResources": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"podmanResources": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"services": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"serviceLevelObjectives": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"onCallDutyPolicies": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"currentIncidentStateId": "123e4567-e89b-12d3-a456-426614174000",
"incidentSeverityId": "123e4567-e89b-12d3-a456-426614174000",
"changeMonitorStatusToId": "123e4567-e89b-12d3-a456-426614174000",
"subscriberNotificationStatusOnIncidentCreated": "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.",
"subscriberNotificationStatusOnPostmortemPublished": "Skipped",
"subscriberNotificationStatusMessageOnPostmortemPublished": "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.",
"shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": true,
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"isOwnerNotifiedOfResourceCreation": true,
"rootCause": "# Heading\n\nThis is **markdown** content",
"postmortemNote": "# Heading\n\nThis is **markdown** content",
"showPostmortemOnStatusPage": true,
"notifySubscribersOnPostmortemPublished": true,
"postmortemPostedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"postmortemAttachments": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"postmortemStatusId": "123e4567-e89b-12d3-a456-426614174000",
"createdStateLog": {
"key": "value",
"nested": {
"data": 123
}
},
"createdCriteriaId": "This is an example of longer text content that might be stored in this field.",
"createdIncidentTemplateId": "This is an example of longer text content that might be stored in this field.",
"seriesFingerprint": "This is an example of longer text content that might be stored in this field.",
"seriesLabels": {
"key": "value",
"nested": {
"data": 123
}
},
"monitorSummary": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByProbeId": "123e4567-e89b-12d3-a456-426614174000",
"isCreatedAutomatically": true,
"holdsMonitors": true,
"postmortemDraftWaitingSince": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"remediationNotes": "# Heading\n\nThis is **markdown** content",
"telemetryQuery": {
"key": "value",
"nested": {
"data": 123
}
},
"incidentNumber": 42,
"incidentNumberWithPrefix": "Example short text",
"isVisibleOnStatusPage": true,
"statusPages": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"isScopedToStatusPages": true,
"statusPagesNotifiedOnCreation": {
"key": "value",
"nested": {
"data": 123
}
},
"isPrivate": true,
"enableReminders": true,
"nextReminderNotificationAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"reminderNotificationSentCount": 42,
"incidentEpisodeId": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.