Class: DatadogAPIClient::V2::EventsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ EventsAPI

Returns a new instance of EventsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_event(body, opts = {}) ⇒ Object

Post an event.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 29

def create_event(body, opts = {})
  data, _status_code, _headers = create_event_with_http_info(body, opts)
  data
end

#create_event_with_http_info(body, opts = {}) ⇒ Array<(EventCreateResponsePayload, Integer, Hash)>

Post an event.

This endpoint allows you to publish events.

Note: To utilize this endpoint with our client libraries, please ensure you are using the latest version released on or after July 1, 2025. Earlier versions do not support this functionality.

Important: Upgrade to the latest client library version to use the updated endpoint at ‘event-management-intake.site/api/v2/events`. Older client library versions of the Post an event (v2) API send requests to a deprecated endpoint (`api.site/api/v2/events`).

✅ **Only events with the ‘change` or `alert` category** are in General Availability. For change events, see [Change Tracking](docs.datadoghq.com/change_tracking) for more details.

❌ For use cases involving other event categories, use the V1 endpoint or reach out to [support](www.datadoghq.com/support/).

❌ Notifications are not yet supported for events sent to this endpoint. Use the V1 endpoint for notification functionality.

Parameters:

  • body (EventCreateRequestPayload) —

    Event creation request payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EventCreateResponsePayload, Integer, Hash)>) —

    EventCreateResponsePayload data, response status code and response headers



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 51

def create_event_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsAPI.create_event ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EventsAPI.create_event"
  end
  # resource path
  local_var_path = '/api/v2/events'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'EventCreateResponsePayload'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_event,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsAPI#create_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_event(event_id, opts = {}) ⇒ Object

Get an event.

See Also:



106
107
108
109
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 106

def get_event(event_id, opts = {})
  data, _status_code, _headers = get_event_with_http_info(event_id, opts)
  data
end

#get_event_with_http_info(event_id, opts = {}) ⇒ Array<(V2EventResponse, Integer, Hash)>

Get an event.

Get the details of an event by ‘event_id`.

Parameters:

  • event_id (String) —

    The UID of the event.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(V2EventResponse, Integer, Hash)>) —

    V2EventResponse data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 118

def get_event_with_http_info(event_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsAPI.get_event ...'
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling EventsAPI.get_event"
  end
  # resource path
  local_var_path = '/api/v2/events/{event_id}'.sub('{event_id}', CGI.escape(event_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V2EventResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_event,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsAPI#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_events(opts = {}) ⇒ Object

Get a list of events.

See Also:



171
172
173
174
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 171

def list_events(opts = {})
  data, _status_code, _headers = list_events_with_http_info(opts)
  data
end

#list_events_with_http_info(opts = {}) ⇒ Array<(EventsListResponse, Integer, Hash)>

Get a list of events.

List endpoint returns events that match an events search query. [Results are paginated similarly to logs](docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest events.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following events syntax.

  • :filter_from (String) —

    Minimum timestamp for requested events, in milliseconds.

  • :filter_to (String) —

    Maximum timestamp for requested events, in milliseconds.

  • :sort (EventsSort) —

    Order of events in results.

  • :page_cursor (String) —

    List following results with a cursor provided in the previous query.

  • :page_limit (Integer) —

    Maximum number of events in the response.

Returns:

  • (Array<(EventsListResponse, Integer, Hash)>) —

    EventsListResponse data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 191

def list_events_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsAPI.list_events ...'
  end
  allowable_values = ['timestamp', '-timestamp']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling EventsAPI.list_events, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
  query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EventsListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_events,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsAPI#list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_events_with_pagination(opts = {}) {|EventResponse| ... } ⇒ Object

Get a list of events.

Provide a paginated version of #list_events, returning all items.

To use it you need to use a block: list_events_with_pagination { |item| p item }

Yields:



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 257

def list_events_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_events(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

#search_events(opts = {}) ⇒ Object

Search events.

See Also:



274
275
276
277
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 274

def search_events(opts = {})
  data, _status_code, _headers = search_events_with_http_info(opts)
  data
end

#search_events_with_http_info(opts = {}) ⇒ Array<(EventsListResponse, Integer, Hash)>

Search events.

List endpoint returns events that match an events search query. [Results are paginated similarly to logs](docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EventsListResponse, Integer, Hash)>) —

    EventsListResponse data, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 289

def search_events_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsAPI.search_events ...'
  end
  # resource path
  local_var_path = '/api/v2/events/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'EventsListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :search_events,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsAPI#search_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_events_with_pagination(opts = {}) {|EventResponse| ... } ⇒ Object

Search events.

Provide a paginated version of #search_events, returning all items.

To use it you need to use a block: search_events_with_pagination { |item| p item }

Yields:



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/datadog_api_client/v2/api/events_api.rb', line 344

def search_events_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "body.page.limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "body.page.limit", EventsListRequest, page_size)
    while true do
        response = search_events(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "body.page.cursor", EventsListRequest, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end