ONoneuptime
Alert

Update Alert

Endpoint to update an existing Alert

put/alert/{id}

Request

Path parameters

idstring uuid required

ID of the Alert to update

Request body

Example request

{
  "data": {
    "title": "This is an example of longer text content that provides detailed information.",
    "currentAlertStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "alertSeverityId": "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,
    "impactStartedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "firstPagedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitor": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "monitorId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "onCallDutyPolicies": [
      {
        "_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"
      }
    ],
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "currentAlertState": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "currentAlertStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "alertSeverity": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "alertSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitorStatusWhenThisAlertWasCreated": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "monitorStatusWhenThisAlertWasCreatedId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "rootCause": null,
    "createdStateLog": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "createdCriteriaId": "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,
    "remediationNotes": null,
    "telemetryQuery": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "alertNumber": 42,
    "alertNumberWithPrefix": "Example Text",
    "alertEpisode": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "alertEpisodeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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.