Class: DatadogAPIClient::V2::AuditAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AuditAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/audit_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/audit_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#list_audit_logs(opts = {}) ⇒ Object

Get a list of Audit Logs events.

See Also:



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

def list_audit_logs(opts = {})
  data, _status_code, _headers = list_audit_logs_with_http_info(opts)
  data
end

#list_audit_logs_with_http_info(opts = {}) ⇒ Array<(AuditLogsEventsResponse, Integer, Hash)>

Get a list of Audit Logs events.

List endpoint returns events that match a Audit Logs search query. [Results are paginated].

Use this endpoint to see your latest Audit Logs events.

[1]: docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following Audit Logs syntax.

  • :filter_from (Time) —

    Minimum timestamp for requested events.

  • :filter_to (Time) —

    Maximum timestamp for requested events.

  • :sort (AuditLogsSort) —

    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<(AuditLogsEventsResponse, Integer, Hash)>) —

    AuditLogsEventsResponse 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
102
103
104
105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/audit_api.rb', line 51

def list_audit_logs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditAPI.list_audit_logs ...'
  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 AuditAPI.list_audit_logs, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/audit/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] || 'AuditLogsEventsResponse'

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

  new_options = opts.merge(
    :operation => :list_audit_logs,
    :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: AuditAPI#list_audit_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_audit_logs_with_pagination(opts = {}) {|AuditLogsEvent| ... } ⇒ Object

Get a list of Audit Logs events.

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

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

Yields:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/datadog_api_client/v2/api/audit_api.rb', line 117

def list_audit_logs_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_audit_logs(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_audit_logs(opts = {}) ⇒ Object

Search Audit Logs events.

See Also:



134
135
136
137
 
# File 'lib/datadog_api_client/v2/api/audit_api.rb', line 134

def search_audit_logs(opts = {})
  data, _status_code, _headers = search_audit_logs_with_http_info(opts)
  data
end

#search_audit_logs_with_http_info(opts = {}) ⇒ Array<(AuditLogsEventsResponse, Integer, Hash)>

Search Audit Logs events.

List endpoint returns Audit Logs events that match an Audit search query. [Results are paginated].

Use this endpoint to build complex Audit Logs events filtering and search.

[1]: docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AuditLogsEventsResponse data, response status code and response headers



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/datadog_api_client/v2/api/audit_api.rb', line 151

def search_audit_logs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditAPI.search_audit_logs ...'
  end
  # resource path
  local_var_path = '/api/v2/audit/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] || 'AuditLogsEventsResponse'

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

  new_options = opts.merge(
    :operation => :search_audit_logs,
    :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: AuditAPI#search_audit_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_audit_logs_with_pagination(opts = {}) {|AuditLogsEvent| ... } ⇒ Object

Search Audit Logs events.

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

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

Yields:



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/datadog_api_client/v2/api/audit_api.rb', line 206

def search_audit_logs_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", AuditLogsSearchEventsRequest, page_size)
    while true do
        response = search_audit_logs(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", AuditLogsSearchEventsRequest, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end