Alert
List Alert
Endpoint to list all Alert items
post/alert/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,
"alertNumberWithPrefix": 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": "High CPU usage detected on production server",
"description": "# Heading\n\nThis is **markdown** content",
"impactStartedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"firstPagedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"monitorId": "123e4567-e89b-12d3-a456-426614174000",
"onCallDutyPolicies": [
{
"_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"
}
],
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"currentAlertStateId": "123e4567-e89b-12d3-a456-426614174000",
"alertSeverityId": "123e4567-e89b-12d3-a456-426614174000",
"monitorStatusWhenThisAlertWasCreatedId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"isOwnerNotifiedOfAlertCreation": true,
"rootCause": "# Heading\n\nThis is **markdown** content",
"createdStateLog": {
"key": "value",
"nested": {
"data": 123
}
},
"createdCriteriaId": "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,
"remediationNotes": "# Heading\n\nThis is **markdown** content",
"telemetryQuery": {
"key": "value",
"nested": {
"data": 123
}
},
"alertNumber": 42,
"alertNumberWithPrefix": "Example short text",
"alertEpisodeId": "123e4567-e89b-12d3-a456-426614174000",
"isPrivate": true,
"enableReminders": true,
"nextReminderNotificationAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"reminderNotificationSentCount": 42,
"nextIncidentRuleCheckAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.