Update User Event

Update User Event

This API supports only user events. The API does not support update of system events (e.g. alert events). The following fields are readonly and will be ignored when passed in the request: id, isEphemeral, isUserEvent, runningState, canDelete, canClose, creatorType, createdAt, updatedAt, createdEpochMillis, updatedEpochMillis, updaterId, creatorId, and summarizedEvents

Request
URI
PUT
https://{api_host}/api/v2/event/{id}
COPY
Path Parameters
string
id
Required

id

Request Body
Event of type(s) application/json
Optional 
{
    "computedHlps": [
        {
            "severity": "string",
            "host": "string",
            "startTime": 0,
            "label": "string",
            "observed": 0,
            "firing": 0
        }
    ],
    "table": "string",
    "name": "string",
    "id": "string",
    "startTime": 0,
    "endTime": 0,
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "tags": [
        "string"
    ],
    "metricsUsed": [
        "string"
    ],
    "createdAt": 0,
    "hosts": [
        "string"
    ],
    "summarizedEvents": 0,
    "alertTags": [
        "string"
    ],
    "isUserEvent": false,
    "isEphemeral": false,
    "creatorId": "string",
    "updaterId": "string",
    "updatedAt": 0,
    "runningState": "string",
    "canDelete": false,
    "canClose": false,
    "creatorType": [
        "string"
    ]
}
array of SourceLabelPair
computedHlps
Optional

All the host/label/tags of the event.

string
table
Optional

The customer to which the event belongs

object
dimensions
Optional

A string-> map of additional dimension info on the event

string
name
Required

The name of the event. If 'annotations.prettyName' is present, 'name' will be equivalent to that value

object
annotations
Required

A string->string map of additional annotations on the event

string
id
Optional

id

integer As int64 As int64
startTime
Required

Start time of the event, in epoch millis. If the JSON value is missing or set to 0, startTime will be set to the current time

integer As int64 As int64
endTime
Optional

End time of the event, in epoch millis. Set to startTime + 1 for an instantaneous event

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

array of string
tags
Optional

A list of event tags

array of string
metricsUsed
Optional

A list of metrics affected by the event

integer As int64 As int64
createdAt
Optional

createdAt

array of string
hosts
Optional

A list of sources/hosts affected by the event

integer As int64 As int64
summarizedEvents
Optional

In some event queries, multiple events that occur nearly simultaneously are summarized under a single event. This value specifies the number of events summarized under this one

array of string
alertTags
Optional

The list of tags on the alert which created this event.

boolean
isUserEvent
Optional

Whether this event was created by a user, versus the system. Default: system

boolean
isEphemeral
Optional

Whether the event is an artificial event generated by a literal expression or alert backtesting, i.e. not stored in the Wavefront backend

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

integer As int64 As int64
updatedAt
Optional

updatedAt

string
runningState
Optional

runningState

Possible values are : ONGOING, PENDING, ENDED,
boolean
canDelete
Optional

canDelete

boolean
canClose
Optional

canClose

array of string
creatorType
Optional

creatorType

Possible values are : USER, ALERT, SYSTEM,
Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerEvent of type(s) application/json 
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "computedHlps": [
            {
                "severity": "string",
                "host": "string",
                "startTime": 0,
                "label": "string",
                "observed": 0,
                "firing": 0
            }
        ],
        "table": "string",
        "name": "string",
        "id": "string",
        "startTime": 0,
        "endTime": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "tags": [
            "string"
        ],
        "metricsUsed": [
            "string"
        ],
        "createdAt": 0,
        "hosts": [
            "string"
        ],
        "summarizedEvents": 0,
        "alertTags": [
            "string"
        ],
        "isUserEvent": false,
        "isEphemeral": false,
        "creatorId": "string",
        "updaterId": "string",
        "updatedAt": 0,
        "runningState": "string",
        "canDelete": false,
        "canClose": false,
        "creatorType": [
            "string"
        ]
    }
}
ResponseStatus
status
Required

status

Event
response
Optional

response


On This Page
Event Operations
PUT
Add Event Tag
POST
Close User Event
POST
Create Event
DELETE
Delete User Event
GET
Get Alert Event Queries Slug
GET
Get Alert Firing Details
GET
Get Alert Firing Events
GET
Get All Events With Time Range
GET
Get Event
GET
Get Event Tags
GET
Get Related Events With Time Span
DELETE
Remove Event Tag
POST
Set Event Tags
PUT
Update User Event