You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*DerivedMetricApi* | [**update_derived_metric**](docs/DerivedMetricApi.md#update_derived_metric) | **PUT** /api/v2/derivedmetric/{id} | Update a specific derived metric definition
180
180
*DirectIngestionApi* | [**report**](docs/DirectIngestionApi.md#report) | **POST** /report | Directly ingest data/data stream with specified format
181
181
*EventApi* | [**add_event_tag**](docs/EventApi.md#add_event_tag) | **PUT** /api/v2/event/{id}/tag/{tagValue} | Add a tag to a specific event
182
-
*EventApi* | [**close_event**](docs/EventApi.md#close_event) | **POST** /api/v2/event/{id}/close | Close a specific event
182
+
*EventApi* | [**close_user_event**](docs/EventApi.md#close_user_event) | **POST** /api/v2/event/{id}/close | Close a specific event
183
183
*EventApi* | [**create_event**](docs/EventApi.md#create_event) | **POST** /api/v2/event | Create a specific event
184
-
*EventApi* | [**delete_event**](docs/EventApi.md#delete_event) | **DELETE** /api/v2/event/{id} | Delete a specific event
184
+
*EventApi* | [**delete_user_event**](docs/EventApi.md#delete_user_event) | **DELETE** /api/v2/event/{id} | Delete a specific user event
185
185
*EventApi* | [**get_alert_event_queries_slug**](docs/EventApi.md#get_alert_event_queries_slug) | **GET** /api/v2/event/{id}/alertQueriesSlug | If the specified event is associated with an alert, returns a slug encoding the queries having to do with that alert firing or resolution
186
186
*EventApi* | [**get_alert_firing_details**](docs/EventApi.md#get_alert_firing_details) | **GET** /api/v2/event/{id}/alertFiringDetails | Return details of a particular alert firing, including all the series that fired during the referred alert firing
187
187
*EventApi* | [**get_alert_firing_events**](docs/EventApi.md#get_alert_firing_events) | **GET** /api/v2/event/alertFirings | Get firings events of an alert within a time range
*EventApi* | [**get_related_events_with_time_span**](docs/EventApi.md#get_related_events_with_time_span) | **GET** /api/v2/event/{id}/events | List all related events for a specific firing event with a time span of one hour
192
192
*EventApi* | [**remove_event_tag**](docs/EventApi.md#remove_event_tag) | **DELETE** /api/v2/event/{id}/tag/{tagValue} | Remove a tag from a specific event
193
193
*EventApi* | [**set_event_tags**](docs/EventApi.md#set_event_tags) | **POST** /api/v2/event/{id}/tag | Set all tags associated with a specific event
194
-
*EventApi* | [**update_event**](docs/EventApi.md#update_event) | **PUT** /api/v2/event/{id} | Update a specific event
194
+
*EventApi* | [**update_user_event**](docs/EventApi.md#update_user_event) | **PUT** /api/v2/event/{id} | Update a specific user event.
195
195
*ExternalLinkApi* | [**create_external_link**](docs/ExternalLinkApi.md#create_external_link) | **POST** /api/v2/extlink | Create a specific external link
196
196
*ExternalLinkApi* | [**delete_external_link**](docs/ExternalLinkApi.md#delete_external_link) | **DELETE** /api/v2/extlink/{id} | Delete a specific external link
197
197
*ExternalLinkApi* | [**get_all_external_link**](docs/ExternalLinkApi.md#get_all_external_link) | **GET** /api/v2/extlink | Get all external links for a customer
Copy file name to clipboardExpand all lines: docs/EventApi.md
+22-22
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@ All URIs are relative to *https://YOUR_INSTANCE.wavefront.com*
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
7
[**add_event_tag**](EventApi.md#add_event_tag) | **PUT** /api/v2/event/{id}/tag/{tagValue} | Add a tag to a specific event
8
-
[**close_event**](EventApi.md#close_event) | **POST** /api/v2/event/{id}/close | Close a specific event
8
+
[**close_user_event**](EventApi.md#close_user_event) | **POST** /api/v2/event/{id}/close | Close a specific event
9
9
[**create_event**](EventApi.md#create_event) | **POST** /api/v2/event | Create a specific event
10
-
[**delete_event**](EventApi.md#delete_event) | **DELETE** /api/v2/event/{id} | Delete a specific event
10
+
[**delete_user_event**](EventApi.md#delete_user_event) | **DELETE** /api/v2/event/{id} | Delete a specific user event
11
11
[**get_alert_event_queries_slug**](EventApi.md#get_alert_event_queries_slug) | **GET** /api/v2/event/{id}/alertQueriesSlug | If the specified event is associated with an alert, returns a slug encoding the queries having to do with that alert firing or resolution
12
12
[**get_alert_firing_details**](EventApi.md#get_alert_firing_details) | **GET** /api/v2/event/{id}/alertFiringDetails | Return details of a particular alert firing, including all the series that fired during the referred alert firing
13
13
[**get_alert_firing_events**](EventApi.md#get_alert_firing_events) | **GET** /api/v2/event/alertFirings | Get firings events of an alert within a time range
[**get_related_events_with_time_span**](EventApi.md#get_related_events_with_time_span) | **GET** /api/v2/event/{id}/events | List all related events for a specific firing event with a time span of one hour
18
18
[**remove_event_tag**](EventApi.md#remove_event_tag) | **DELETE** /api/v2/event/{id}/tag/{tagValue} | Remove a tag from a specific event
19
19
[**set_event_tags**](EventApi.md#set_event_tags) | **POST** /api/v2/event/{id}/tag | Set all tags associated with a specific event
20
-
[**update_event**](EventApi.md#update_event) | **PUT** /api/v2/event/{id} | Update a specific event
20
+
[**update_user_event**](EventApi.md#update_user_event) | **PUT** /api/v2/event/{id} | Update a specific user event.
21
21
22
22
23
23
# **add_event_tag**
@@ -76,12 +76,12 @@ Name | Type | Description | Notes
76
76
77
77
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
78
78
79
-
# **close_event**
80
-
> ResponseContainerEvent close_event(id)
79
+
# **close_user_event**
80
+
> ResponseContainerEvent close_user_event(id)
81
81
82
82
Close a specific event
83
83
84
-
84
+
This API supports only user events. The API does <strong>not</strong> support close of system events (e.g. alert events).
85
85
86
86
### Example
87
87
```python
@@ -103,10 +103,10 @@ id = 'id_example' # str |
103
103
104
104
try:
105
105
# Close a specific event
106
-
api_response = api_instance.close_event(id)
106
+
api_response = api_instance.close_user_event(id)
107
107
pprint(api_response)
108
108
except ApiException as e:
109
-
print("Exception when calling EventApi->close_event: %s\n"% e)
109
+
print("Exception when calling EventApi->close_user_event: %s\n"% e)
110
110
```
111
111
112
112
### Parameters
@@ -184,12 +184,12 @@ Name | Type | Description | Notes
184
184
185
185
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
186
186
187
-
# **delete_event**
188
-
> ResponseContainerEvent delete_event(id)
189
-
190
-
Delete a specific event
187
+
# **delete_user_event**
188
+
> ResponseContainerEvent delete_user_event(id)
191
189
190
+
Delete a specific user event
192
191
192
+
This API supports only user events. The API does <strong>not</strong> support deletion of system events (e.g. alert events).
print("Exception when calling EventApi->delete_event: %s\n"% e)
217
+
print("Exception when calling EventApi->delete_user_event: %s\n"% e)
218
218
```
219
219
220
220
### Parameters
@@ -748,12 +748,12 @@ Name | Type | Description | Notes
748
748
749
749
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
The following fields are readonly and will be ignored when passed in the request: <code>id</code>, <code>isEphemeral</code>, <code>isUserEvent</code>, <code>runningState</code>, <code>canDelete</code>, <code>canClose</code>, <code>creatorType</code>, <code>createdAt</code>, <code>updatedAt</code>, <code>createdEpochMillis</code>, <code>updatedEpochMillis</code>, <code>updaterId</code>, <code>creatorId</code>, and <code>summarizedEvents</code>
756
+
This API supports only user events. The API does <strong>not</strong> support update of system events (e.g. alert events). The following fields are readonly and will be ignored when passed in the request: <code>id</code>, <code>isEphemeral</code>, <code>isUserEvent</code>, <code>runningState</code>, <code>canDelete</code>, <code>canClose</code>, <code>creatorType</code>, <code>createdAt</code>, <code>updatedAt</code>, <code>createdEpochMillis</code>, <code>updatedEpochMillis</code>, <code>updaterId</code>, <code>creatorId</code>, and <code>summarizedEvents</code>
0 commit comments