Class: DatadogAPIClient::V2::GovernanceControlsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of GovernanceControlsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_governance_control(detection_type, opts = {}) ⇒ Object

Get a governance control.

See Also:



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

def get_governance_control(detection_type, opts = {})
  data, _status_code, _headers = get_governance_control_with_http_info(detection_type, opts)
  data
end

#get_governance_control_with_http_info(detection_type, opts = {}) ⇒ Array<(GovernanceControlResponse, Integer, Hash)>

Get a governance control.

Retrieve a single governance control by its detection type, including the organization's current detection, notification, and mitigation configuration and detection counts.

Parameters:

  • detection_type (String) —

    The detection type that identifies the control, for example unused_api_keys.

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

    the optional parameters

Returns:

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

    GovernanceControlResponse data, response status code and response headers



42
43
44
45
46
47
48
49
50
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
 
# File 'lib/datadog_api_client/v2/api/governance_controls_api.rb', line 42

def get_governance_control_with_http_info(detection_type, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_governance_control".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_governance_control")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_governance_control"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GovernanceControlsAPI.get_governance_control ...'
  end
  # verify the required parameter 'detection_type' is set
  if @api_client.config.client_side_validation && detection_type.nil?
    fail ArgumentError, "Missing the required parameter 'detection_type' when calling GovernanceControlsAPI.get_governance_control"
  end
  # resource path
  local_var_path = '/api/v2/governance/control/{detection_type}'.sub('{detection_type}', CGI.escape(detection_type.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] || 'GovernanceControlResponse'

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

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

#list_governance_controls(opts = {}) ⇒ Object

List governance controls.

See Also:



101
102
103
104
 
# File 'lib/datadog_api_client/v2/api/governance_controls_api.rb', line 101

def list_governance_controls(opts = {})
  data, _status_code, _headers = list_governance_controls_with_http_info(opts)
  data
end

#list_governance_controls_with_http_info(opts = {}) ⇒ Array<(GovernanceControlsResponse, Integer, Hash)>

List governance controls.

Retrieve the list of governance controls configured for the organization. Each control pairs a detection definition with the organization's current detection, notification, and mitigation configuration, along with counts of active and mitigated detections.

Parameters:

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

    the optional parameters

Returns:

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

    GovernanceControlsResponse data, response status code and response headers



114
115
116
117
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
 
# File 'lib/datadog_api_client/v2/api/governance_controls_api.rb', line 114

def list_governance_controls_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_governance_controls".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_governance_controls")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_governance_controls"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GovernanceControlsAPI.list_governance_controls ...'
  end
  # resource path
  local_var_path = '/api/v2/governance/control'

  # 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] || 'GovernanceControlsResponse'

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

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

#update_governance_control(detection_type, body, opts = {}) ⇒ Object

Update a governance control.

See Also:



169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/governance_controls_api.rb', line 169

def update_governance_control(detection_type, body, opts = {})
  data, _status_code, _headers = update_governance_control_with_http_info(detection_type, body, opts)
  data
end

#update_governance_control_with_http_info(detection_type, body, opts = {}) ⇒ Array<(GovernanceControlResponse, Integer, Hash)>

Update a governance control.

Update the detection, notification, and mitigation configuration of a governance control. Only the attributes present in the request are modified. Changing the mitigation type or its parameters may require additional permissions.

Parameters:

  • detection_type (String) —

    The detection type that identifies the control, for example unused_api_keys.

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

    the optional parameters

Returns:

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

    GovernanceControlResponse data, response status code and response headers



184
185
186
187
188
189
190
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
 
# File 'lib/datadog_api_client/v2/api/governance_controls_api.rb', line 184

def update_governance_control_with_http_info(detection_type, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_governance_control".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_governance_control")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_governance_control"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GovernanceControlsAPI.update_governance_control ...'
  end
  # verify the required parameter 'detection_type' is set
  if @api_client.config.client_side_validation && detection_type.nil?
    fail ArgumentError, "Missing the required parameter 'detection_type' when calling GovernanceControlsAPI.update_governance_control"
  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 GovernanceControlsAPI.update_governance_control"
  end
  # resource path
  local_var_path = '/api/v2/governance/control/{detection_type}'.sub('{detection_type}', CGI.escape(detection_type.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'])
  # 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] || 'GovernanceControlResponse'

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

  new_options = opts.merge(
    :operation => :update_governance_control,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GovernanceControlsAPI#update_governance_control\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end