Skip to content

Event management service

The event management service provides resources for updating existing events, either with new status information or with text annotations. To create an event, use the create events resource of the data receiver service.

Resource list

POST /v1/event-management/annotate

Create or update the annotation field of one or more events.

To create an event, use the create events resource.

Info

To obtain values for the occurrenceId and annotationId fields, display the details of the event to annotate in an events console.

Request template

Abstract previews of JSON requests to create or update one event annotation.

{
  "annotations": [
    {
      "eventId": "<event-id>",
      "occurrenceId": "<occurence-id>",
      "annotation": "<annotation>"
    }
  ]
}

{
  "annotations": [
    {
      "eventId": "<event-id>",
      "occurrenceId": "<occurence-id>",
      "annotationId": "<annotation-id>",
      "annotation": "<annotation>"
    }
  ]
}

Request fields

annotations (array, required)
One or more event annotation specifications.
eventId (string, required)
The identifier of an event.
occurrenceId (string, required)
The occurrence identifier of an event.
annotationId (string, optional)
The identifier of an event annotation. For updates, this field is required.
annotation (string, optional)
The text of an annotation. For updates, the content of this field replaces the existing content of an event annotation, if any.

Status codes

  • 200 (full or partial success; see response message)
  • 500 (missing or invalid authentication key)

Example

curl https://YOUR-API-ENDPOINT/v1/event-management/annotate \
  -H "content-type: application/json" \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X POST -s -S -d \
'{
  "annotations": [
    {
      "eventId": "AAAABWRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABWRDWOPER3lzOFI2tSCG49g=:1",
      "annotation": "my sample annotation"
    },
    {
      "eventId": "AAAEDBRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "GOLABWRDWOPER3lzOFI2tSCG49g=:16",
      "annotationId": "4cVf7RnzENAbMLXdt8Qu",
      "annotation": "my sample annotation update"
    }
  ]
}'

{
  "annotationResponses": [
    {
      "eventId": "AAAABWRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABWRDWOPER3lzOFI2tSCG49g=:1",
      "annotationId": "3BDeyX0rnToJgKvEEaPk",
      "success": true
    },
    {
      "eventId": "AAAEDBRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "GOLABWRDWOPER3lzOFI2tSCG49g=:16",
      "success": true
    }
  ]
}

POST /v1/event-management/status

Update the status of one or more events.

To create an event, use the create events resource.

Info

To obtain values for the occurrenceId and annotationId fields, display the details of the event to update in an events console.

Request template

Abstract previews of JSON requests to update event status information.

{
  "statuses": [
    {
      "eventId": "<event-id>",
      "occurrenceId": "<occurence-id>",
      "statusWrapper": {
        "status": "<status>"
      }
    }
  ]
}

{
  "statuses": [
    {
      "eventId": "<event-id>",
      "occurrenceId": "<occurence-id>",
      "acknowledged": <boolean>
    }
  ]
}

Request fields

statuses (array, required)
One or more event status specifications.
eventId (string, required)
The identifier of an event.
occurrenceId (string, required)
The occurrence identifier of an event.
acknowledged (boolean, optional, default = false)
The acknowledgement state of the event, acknowledged (true) or not acknowledged (false). This field or the statusWrapper field must be included in a request.
statusWrapper (object, optional)
A container for a status string. This field or the acknowledged field must be included in a request.
status (string, optional)

The status of the event.

  • STATUS_DEFAULT - Unknown at this time
  • STATUS_OPEN - Known to be in progress at this time
  • STATUS_SUPPRESSED - Should be ended
  • STATUS_CLOSED - Known to be ended

Status codes

  • 200 (full or partial success; see response message)
  • 500 (missing or invalid authentication key)

Example

curl https://YOUR-API-ENDPOINT/v1/event-management/status \
  -H "content-type: application/json" \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X POST -s -S -d \
'{
  "statuses": [
    {
      "eventId": "AAAABWRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABWRDWOPER3lzOFI2tSCG49g=:1",
      "acknowledged": true
    },
    {
      "eventId": "AAAAEVBDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABFNJDWOPER3lzOFI2tSCG49g=:134",
      "statusWrapper": {
        "status": "EM_STATUS_SUPPRESSED"
      }
    }
  ]
}'

{
  "statusResponses": [
    {
      "eventId": "AAAABWRDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABWRDWOPER3lzOFI2tSCG49g=:1",
      "success": true
    },
    {
      "eventId": "AAAAEVBDWOPER3lzOFI2tSCG49g=",
      "occurrenceId": "AAAABFNJDWOPER3lzOFI2tSCG49g=:134",
      "success": true
    }
  ]
}