Class: DatadogAPIClient::V2::FeatureFlagsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of FeatureFlagsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#archive_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Archive a feature flag.

See Also:



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

def archive_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = archive_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#archive_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Archive a feature flag.

Archives a feature flag. Archived flags are hidden from the main list but remain accessible and can be unarchived.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

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

    the optional parameters

Returns:

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

    FeatureFlagResponse 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
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 42

def archive_feature_flag_with_http_info(feature_flag_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.archive_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.archive_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/archive'.sub('{feature_flag_id}', CGI.escape(feature_flag_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] || 'FeatureFlagResponse'

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

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

#create_allocations_for_feature_flag_in_environment(feature_flag_id, environment_id, body, opts = {}) ⇒ Object

Create targeting rules for a flag env.

See Also:



95
96
97
98
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 95

def create_allocations_for_feature_flag_in_environment(feature_flag_id, environment_id, body, opts = {})
  data, _status_code, _headers = create_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts)
  data
end

#create_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts = {}) ⇒ Array<(AllocationResponse, Integer, Hash)>

Create targeting rules for a flag env.

Creates a new targeting rule (allocation) for a specific feature flag in a specific environment.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    AllocationResponse data, response status code and response headers



109
110
111
112
113
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
165
166
167
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 109

def create_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_allocations_for_feature_flag_in_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.create_allocations_for_feature_flag_in_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.create_allocations_for_feature_flag_in_environment"
  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 FeatureFlagsAPI.create_allocations_for_feature_flag_in_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/allocations'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_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'])
  # 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] || 'AllocationResponse'

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

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

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

Create a feature flag.

See Also:



172
173
174
175
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 172

def create_feature_flag(body, opts = {})
  data, _status_code, _headers = create_feature_flag_with_http_info(body, opts)
  data
end

#create_feature_flag_with_http_info(body, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Create a feature flag.

Creates a new feature flag with variants.

Parameters:

Returns:

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

    FeatureFlagResponse 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
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 184

def create_feature_flag_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_feature_flag ...'
  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 FeatureFlagsAPI.create_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags'

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

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

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

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

Create an environment.

See Also:



239
240
241
242
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 239

def create_feature_flags_environment(body, opts = {})
  data, _status_code, _headers = create_feature_flags_environment_with_http_info(body, opts)
  data
end

#create_feature_flags_environment_with_http_info(body, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Create an environment.

Creates a new environment for organizing feature flags.

Parameters:

Returns:

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

    EnvironmentResponse data, response status code and response headers



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 251

def create_feature_flags_environment_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_feature_flags_environment ...'
  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 FeatureFlagsAPI.create_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments'

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

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

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

#create_variant_for_feature_flag(feature_flag_id, body, opts = {}) ⇒ Object

Add a variant to a feature flag.

See Also:



306
307
308
309
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 306

def create_variant_for_feature_flag(feature_flag_id, body, opts = {})
  data, _status_code, _headers = create_variant_for_feature_flag_with_http_info(feature_flag_id, body, opts)
  data
end

#create_variant_for_feature_flag_with_http_info(feature_flag_id, body, opts = {}) ⇒ Array<(Variant, Integer, Hash)>

Add a variant to a feature flag.

Adds a single new variant to an existing feature flag. This endpoint is additive-only: it never modifies existing variants. A request whose key already exists on the flag is rejected with 409 Conflict; a value whose type does not match the flag's value_type is rejected with 400. The server generates the variant UUID and returns it in the response body; callers (for example, the flag-migration tool) need this UUID to reference the new variant in subsequent allocation syncs.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 325

def create_variant_for_feature_flag_with_http_info(feature_flag_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_variant_for_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.create_variant_for_feature_flag"
  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 FeatureFlagsAPI.create_variant_for_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/variants'.sub('{feature_flag_id}', CGI.escape(feature_flag_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'])
  # 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] || 'Variant'

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

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

#delete_feature_flags_environment(environment_id, opts = {}) ⇒ Object

Delete an environment.

See Also:



384
385
386
387
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 384

def delete_feature_flags_environment(environment_id, opts = {})
  delete_feature_flags_environment_with_http_info(environment_id, opts)
  nil
end

#delete_feature_flags_environment_with_http_info(environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an environment.

Deletes an environment. This operation cannot be undone.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 396

def delete_feature_flags_environment_with_http_info(environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.delete_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.delete_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_variant_from_feature_flag(feature_flag_id, variant_id, opts = {}) ⇒ Object

Delete a variant.

See Also:



449
450
451
452
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 449

def delete_variant_from_feature_flag(feature_flag_id, variant_id, opts = {})
  delete_variant_from_feature_flag_with_http_info(feature_flag_id, variant_id, opts)
  nil
end

#delete_variant_from_feature_flag_with_http_info(feature_flag_id, variant_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a variant.

Deletes a variant from a feature flag.

When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a FlagSuggestion with 201 Created instead of deleting the variant immediately. If a pending suggestion already exists for this flag's variant property, the endpoint returns 409 Conflict.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • variant_id (UUID) —

    The ID of the variant.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 464

def delete_variant_from_feature_flag_with_http_info(feature_flag_id, variant_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.delete_variant_from_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.delete_variant_from_feature_flag"
  end
  # verify the required parameter 'variant_id' is set
  if @api_client.config.client_side_validation && variant_id.nil?
    fail ArgumentError, "Missing the required parameter 'variant_id' when calling FeatureFlagsAPI.delete_variant_from_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/variants/{variant_id}'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{variant_id}', CGI.escape(variant_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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#disable_feature_flag_environment(feature_flag_id, environment_id, opts = {}) ⇒ Object

Disable a feature flag in an environment.

See Also:



521
522
523
524
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 521

def disable_feature_flag_environment(feature_flag_id, environment_id, opts = {})
  disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts)
  nil
end

#disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable a feature flag in an environment.

Disable a feature flag in a specific environment.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 534

def disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.disable_feature_flag_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.disable_feature_flag_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.disable_feature_flag_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/disable'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#enable_feature_flag_environment(feature_flag_id, environment_id, opts = {}) ⇒ Object

Enable a feature flag in an environment.

See Also:



591
592
593
594
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 591

def enable_feature_flag_environment(feature_flag_id, environment_id, opts = {})
  enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts)
  nil
end

#enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable a feature flag in an environment.

Enable a feature flag in a specific environment.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 604

def enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.enable_feature_flag_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.enable_feature_flag_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.enable_feature_flag_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/enable'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Get a feature flag.

See Also:



661
662
663
664
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 661

def get_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = get_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#get_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Get a feature flag.

Returns the details of a specific feature flag including variants and environment status.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

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

    the optional parameters

Returns:

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

    FeatureFlagResponse data, response status code and response headers



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 674

def get_feature_flag_with_http_info(feature_flag_id, opts = {})

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

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

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

#get_feature_flags_environment(environment_id, opts = {}) ⇒ Object

Get an environment.

See Also:



727
728
729
730
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 727

def get_feature_flags_environment(environment_id, opts = {})
  data, _status_code, _headers = get_feature_flags_environment_with_http_info(environment_id, opts)
  data
end

#get_feature_flags_environment_with_http_info(environment_id, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Get an environment.

Returns the details of a specific environment.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    EnvironmentResponse data, response status code and response headers



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 739

def get_feature_flags_environment_with_http_info(environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.get_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.get_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_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] || 'EnvironmentResponse'

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

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

#get_saved_filter(saved_filter_id, opts = {}) ⇒ Object

Get a saved filter.

See Also:



792
793
794
795
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 792

def get_saved_filter(saved_filter_id, opts = {})
  data, _status_code, _headers = get_saved_filter_with_http_info(saved_filter_id, opts)
  data
end

#get_saved_filter_with_http_info(saved_filter_id, opts = {}) ⇒ Array<(SavedFilterResponse, Integer, Hash)>

Get a saved filter.

Returns a saved filter by ID, including its full targeting rules, conditions, and values. Supports both saved lists and saved rules. Targeting rules are combined with OR, and conditions within each rule are combined with AND. Returns the stored filter definition rather than evaluating it against users or organizations. Archived filters can be retrieved. Filters that are deleted or belong to another organization return a not found error.

Parameters:

  • saved_filter_id (UUID) —

    The ID of the saved filter.

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

    the optional parameters

Returns:

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

    SavedFilterResponse data, response status code and response headers



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 808

def get_saved_filter_with_http_info(saved_filter_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.get_saved_filter ...'
  end
  # verify the required parameter 'saved_filter_id' is set
  if @api_client.config.client_side_validation && saved_filter_id.nil?
    fail ArgumentError, "Missing the required parameter 'saved_filter_id' when calling FeatureFlagsAPI.get_saved_filter"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/saved-filters/{saved_filter_id}'.sub('{saved_filter_id}', CGI.escape(saved_filter_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] || 'SavedFilterResponse'

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

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

#list_feature_flags(opts = {}) ⇒ Object

List feature flags.

See Also:



861
862
863
864
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 861

def list_feature_flags(opts = {})
  data, _status_code, _headers = list_feature_flags_with_http_info(opts)
  data
end

#list_feature_flags_environments(opts = {}) ⇒ Object

List environments.

See Also:



984
985
986
987
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 984

def list_feature_flags_environments(opts = {})
  data, _status_code, _headers = list_feature_flags_environments_with_http_info(opts)
  data
end

#list_feature_flags_environments_with_http_info(opts = {}) ⇒ Array<(ListEnvironmentsResponse, Integer, Hash)>

List environments.

Returns a list of environments for the organization. Supports filtering by name, key, and DD_ENV.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter environments by name (partial matching).

  • :key (String) —

    Filter environments by key (partial matching).

  • :dd_env (String) —

    Filter environments by queries that contain the provided DD_ENV value.

  • :limit (Integer) —

    Maximum number of results to return.

  • :offset (Integer) —

    Number of results to skip.

Returns:

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

    ListEnvironmentsResponse data, response status code and response headers



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1001

def list_feature_flags_environments_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.list_feature_flags_environments ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'dd_env'] = opts[:'dd_env'] if !opts[:'dd_env'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'ListEnvironmentsResponse'

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

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

#list_feature_flags_with_http_info(opts = {}) ⇒ Array<(ListFeatureFlagsResponse, Integer, Hash)>

List feature flags.

Returns a paginated list of feature flags for the organization. Supports filtering by key, tags, teams, SDK availability, production status, and other flag properties. Use page[limit] and page[offset] to paginate, or follow the next link in the response.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :key (String) —

    Filter feature flags by an exact, case-sensitive key. Use search for partial matching.

  • :is_archived (Boolean) —

    Filter by archived status. If true, return only archived flags. If false, return only flags that are not archived. If omitted, return both.

  • :limit (Integer) —

    Deprecated alias for page[limit]. Use page[limit] for new requests. Used only when page[limit] is absent. When both parameters are omitted, the server defaults to 25. Values that exceed 50 are set to 50; non-positive or empty values use the server default.

  • :offset (Integer) —

    Deprecated alias for page[offset]. Used only when page[offset] is absent. Defaults to 0. Negative or empty values are set to 0.

  • :tags (Array<String>) —

    Filter by exact tag values using repeated parameters, such as tags=env:prod&tags=purpose:sitemap. A flag must have all ordinary tags. Values of the form team:<handle> match any selected team and are combined with teams into one set. The result must match all ordinary tags, any selected team, and all other filters. Empty values are ignored.

  • :teams (Array<String>) —

    Filter by team handles without the team: prefix. Use repeated parameters to filter by multiple team handles, such as teams=checkout&teams=payments. A flag must belong to at least one selected team. Team handles from teams and team:<handle> values from tags are treated as a single set and combined with ordinary tags and other filters using AND logic. Duplicate handles do not duplicate results. Unknown handles do not match any flags. Empty handles, surrounding white space, or using the team: prefix return a bad request error. Response tags are unchanged.

  • :production_status (Array<FeatureFlagProductionStatus>) —

    Filter by status across production environments. Use repeated parameters to match any selected status. ENABLED matches at least one enabled production environment without a variant override. OVERRIDDEN matches at least one enabled production environment with a variant override. DISABLED matches flags whose associated production environments are all disabled. A flag can match both ENABLED and OVERRIDDEN in different environments. Flags without associated production environments do not match. This does not filter by a specific environment. Unknown values do not match any status.

  • :distribution_channel (FeatureFlagDistributionChannel) —

    Filter by SDK availability. CLIENT returns flags with channel CLIENT or ALL. SERVER returns flags with channel SERVER or ALL. ALL, an empty value, or omission applies no channel restriction; it does not select only flags whose channel is ALL. Values are case-insensitive and surrounding white space is ignored. Invalid values return a bad request error.

  • :search (String) —

    Case-insensitive substring search on flag names, keys, and tag names. Combined with all other filters. An empty value applies no search restriction.

  • :value_type (Array<ValueType>) —

    Filter by variant value types using repeated parameters. A flag must match at least one selected type. Empty values are ignored. Invalid types return a bad request error.

  • :created_by (Array<UUID>) —

    Filter by creator UUIDs using repeated parameters. A flag must match at least one creator. Empty values are ignored. Invalid UUIDs return a bad request error.

  • :flag_ids (Array<UUID>) —

    Filter by feature flag UUIDs using repeated parameters. A flag must match at least one ID and all other filters. Duplicate IDs return each flag once. Unknown IDs and IDs from other organizations do not match any flags. Empty or invalid UUIDs return a bad request error. Pagination still applies.

  • :staleness_status (FeatureFlagStalenessStatus) —

    Filter by the computed staleness status: ACTIVE, STALE, or PERMANENT. Values are case-insensitive and surrounding white space is ignored. An empty value or omission applies no restriction. Invalid values return a bad request error. Read the computed result from staleness_details.staleness_status, not the legacy staleness_status response field.

  • :saved_filter_id (UUID) —

    Filter to flags that reference this saved filter in their targeting conditions. An empty value or omission applies no restriction. An invalid UUID returns a bad request error.

  • :sort (String) —

    Sort by name, updated_at, created_at, or evaluations. Use a comma-separated list for multiple sort fields and prefix a field with - for descending order. The default is updated_at descending. When favorites are enabled, the authenticated user's favorite flags take precedence over the selected ordering. Unknown fields return a bad request error.

  • :page_limit (Integer) —

    Maximum number of flags to return. Defaults to 25 and is capped at 50. Values that exceed 50 are set to 50. Non-positive or empty values use the default. A non-integer value returns a bad request error. Takes precedence over limit when both are present. Pagination applies even when no pagination parameters are supplied.

  • :page_offset (Integer) —

    Number of matching flags to skip before returning results. Defaults to 0. Negative or empty values are set to 0. A non-integer value returns a bad request error. Takes precedence over offset when both are present.

Returns:

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

    ListFeatureFlagsResponse data, response status code and response headers



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 891

def list_feature_flags_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.list_feature_flags ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 0.'
  end
  allowable_values = ['ALL', 'CLIENT', 'SERVER']
  if @api_client.config.client_side_validation && opts[:'distribution_channel'] && !allowable_values.include?(opts[:'distribution_channel'])
    fail ArgumentError, "invalid value for \"distribution_channel\", must be one of #{allowable_values}"
  end
  allowable_values = ['ACTIVE', 'STALE', 'PERMANENT']
  if @api_client.config.client_side_validation && opts[:'staleness_status'] && !allowable_values.include?(opts[:'staleness_status'])
    fail ArgumentError, "invalid value for \"staleness_status\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be smaller than or equal to 50.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_offset'].nil? && opts[:'page_offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_offset"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/feature-flags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'is_archived'] = opts[:'is_archived'] if !opts[:'is_archived'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
  query_params[:'teams'] = @api_client.build_collection_param(opts[:'teams'], :multi) if !opts[:'teams'].nil?
  query_params[:'production_status'] = @api_client.build_collection_param(opts[:'production_status'], :multi) if !opts[:'production_status'].nil?
  query_params[:'distribution_channel'] = opts[:'distribution_channel'] if !opts[:'distribution_channel'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'value_type'] = @api_client.build_collection_param(opts[:'value_type'], :multi) if !opts[:'value_type'].nil?
  query_params[:'created_by'] = @api_client.build_collection_param(opts[:'created_by'], :multi) if !opts[:'created_by'].nil?
  query_params[:'flag_ids'] = @api_client.build_collection_param(opts[:'flag_ids'], :multi) if !opts[:'flag_ids'].nil?
  query_params[:'staleness_status'] = opts[:'staleness_status'] if !opts[:'staleness_status'].nil?
  query_params[:'saved_filter_id'] = opts[:'saved_filter_id'] if !opts[:'saved_filter_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'ListFeatureFlagsResponse'

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

  new_options = opts.merge(
    :operation => :list_feature_flags,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  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: FeatureFlagsAPI#list_feature_flags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pause_exposure_schedule(exposure_schedule_id, opts = {}) ⇒ Object

Pause a progressive rollout.

See Also:



1064
1065
1066
1067
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1064

def pause_exposure_schedule(exposure_schedule_id, opts = {})
  data, _status_code, _headers = pause_exposure_schedule_with_http_info(exposure_schedule_id, opts)
  data
end

#pause_exposure_schedule_with_http_info(exposure_schedule_id, opts = {}) ⇒ Array<(AllocationExposureScheduleResponse, Integer, Hash)>

Pause a progressive rollout.

Pauses a progressive rollout while preserving rollout state.

Parameters:

  • exposure_schedule_id (UUID) —

    The ID of the exposure schedule.

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

    the optional parameters

Returns:



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1076

def pause_exposure_schedule_with_http_info(exposure_schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.pause_exposure_schedule ...'
  end
  # verify the required parameter 'exposure_schedule_id' is set
  if @api_client.config.client_side_validation && exposure_schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'exposure_schedule_id' when calling FeatureFlagsAPI.pause_exposure_schedule"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause'.sub('{exposure_schedule_id}', CGI.escape(exposure_schedule_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] || 'AllocationExposureScheduleResponse'

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

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

#resume_exposure_schedule(exposure_schedule_id, opts = {}) ⇒ Object

Resume a progressive rollout.

See Also:



1129
1130
1131
1132
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1129

def resume_exposure_schedule(exposure_schedule_id, opts = {})
  data, _status_code, _headers = resume_exposure_schedule_with_http_info(exposure_schedule_id, opts)
  data
end

#resume_exposure_schedule_with_http_info(exposure_schedule_id, opts = {}) ⇒ Array<(AllocationExposureScheduleResponse, Integer, Hash)>

Resume a progressive rollout.

Resumes progression for a previously paused progressive rollout.

Parameters:

  • exposure_schedule_id (UUID) —

    The ID of the exposure schedule.

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

    the optional parameters

Returns:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1141

def resume_exposure_schedule_with_http_info(exposure_schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.resume_exposure_schedule ...'
  end
  # verify the required parameter 'exposure_schedule_id' is set
  if @api_client.config.client_side_validation && exposure_schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'exposure_schedule_id' when calling FeatureFlagsAPI.resume_exposure_schedule"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/resume'.sub('{exposure_schedule_id}', CGI.escape(exposure_schedule_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] || 'AllocationExposureScheduleResponse'

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

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

#start_exposure_schedule(exposure_schedule_id, opts = {}) ⇒ Object

Start a progressive rollout.

See Also:



1194
1195
1196
1197
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1194

def start_exposure_schedule(exposure_schedule_id, opts = {})
  data, _status_code, _headers = start_exposure_schedule_with_http_info(exposure_schedule_id, opts)
  data
end

#start_exposure_schedule_with_http_info(exposure_schedule_id, opts = {}) ⇒ Array<(AllocationExposureScheduleResponse, Integer, Hash)>

Start a progressive rollout.

Starts a progressive rollout and begins progression.

Parameters:

  • exposure_schedule_id (UUID) —

    The ID of the exposure schedule.

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

    the optional parameters

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1206

def start_exposure_schedule_with_http_info(exposure_schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.start_exposure_schedule ...'
  end
  # verify the required parameter 'exposure_schedule_id' is set
  if @api_client.config.client_side_validation && exposure_schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'exposure_schedule_id' when calling FeatureFlagsAPI.start_exposure_schedule"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/start'.sub('{exposure_schedule_id}', CGI.escape(exposure_schedule_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] || 'AllocationExposureScheduleResponse'

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

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

#stop_exposure_schedule(exposure_schedule_id, opts = {}) ⇒ Object

Stop a progressive rollout.

See Also:



1259
1260
1261
1262
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1259

def stop_exposure_schedule(exposure_schedule_id, opts = {})
  data, _status_code, _headers = stop_exposure_schedule_with_http_info(exposure_schedule_id, opts)
  data
end

#stop_exposure_schedule_with_http_info(exposure_schedule_id, opts = {}) ⇒ Array<(AllocationExposureScheduleResponse, Integer, Hash)>

Stop a progressive rollout.

Stops a progressive rollout and marks it as aborted.

Parameters:

  • exposure_schedule_id (UUID) —

    The ID of the exposure schedule.

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

    the optional parameters

Returns:



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1271

def stop_exposure_schedule_with_http_info(exposure_schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.stop_exposure_schedule ...'
  end
  # verify the required parameter 'exposure_schedule_id' is set
  if @api_client.config.client_side_validation && exposure_schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'exposure_schedule_id' when calling FeatureFlagsAPI.stop_exposure_schedule"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/stop'.sub('{exposure_schedule_id}', CGI.escape(exposure_schedule_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] || 'AllocationExposureScheduleResponse'

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

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

#unarchive_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Unarchive a feature flag.

See Also:



1324
1325
1326
1327
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1324

def unarchive_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = unarchive_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#unarchive_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Unarchive a feature flag.

Unarchives a previously archived feature flag, making it visible in the main list again.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

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

    the optional parameters

Returns:

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

    FeatureFlagResponse data, response status code and response headers



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1337

def unarchive_feature_flag_with_http_info(feature_flag_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.unarchive_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.unarchive_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/unarchive'.sub('{feature_flag_id}', CGI.escape(feature_flag_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] || 'FeatureFlagResponse'

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

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

#update_allocations_for_feature_flag_in_environment(feature_flag_id, environment_id, body, opts = {}) ⇒ Object

Update targeting rules for a flag.

See Also:



1390
1391
1392
1393
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1390

def update_allocations_for_feature_flag_in_environment(feature_flag_id, environment_id, body, opts = {})
  data, _status_code, _headers = update_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts)
  data
end

#update_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts = {}) ⇒ Array<(ListAllocationsResponse, Integer, Hash)>

Update targeting rules for a flag.

Updates targeting rules (allocations) for a specific feature flag in a specific environment. This operation replaces the existing allocation set with the request payload.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    ListAllocationsResponse data, response status code and response headers



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1405

def update_allocations_for_feature_flag_in_environment_with_http_info(feature_flag_id, environment_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_allocations_for_feature_flag_in_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.update_allocations_for_feature_flag_in_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.update_allocations_for_feature_flag_in_environment"
  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 FeatureFlagsAPI.update_allocations_for_feature_flag_in_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/allocations'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_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'])
  # 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] || 'ListAllocationsResponse'

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

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

#update_feature_flag(feature_flag_id, body, opts = {}) ⇒ Object

Update a feature flag.

See Also:



1468
1469
1470
1471
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1468

def update_feature_flag(feature_flag_id, body, opts = {})
  data, _status_code, _headers = update_feature_flag_with_http_info(feature_flag_id, body, opts)
  data
end

#update_feature_flag_with_http_info(feature_flag_id, body, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Update a feature flag.

Updates an existing feature flag's metadata such as name and description. Does not modify targeting rules or allocations.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

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

    the optional parameters

Returns:

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

    FeatureFlagResponse data, response status code and response headers



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1482

def update_feature_flag_with_http_info(feature_flag_id, body, opts = {})

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

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

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

#update_feature_flags_environment(environment_id, body, opts = {}) ⇒ Object

Update an environment.

See Also:



1541
1542
1543
1544
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1541

def update_feature_flags_environment(environment_id, body, opts = {})
  data, _status_code, _headers = update_feature_flags_environment_with_http_info(environment_id, body, opts)
  data
end

#update_feature_flags_environment_with_http_info(environment_id, body, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Update an environment.

Updates an existing environment's metadata such as name and description.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

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

    the optional parameters

Returns:

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

    EnvironmentResponse data, response status code and response headers



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1555

def update_feature_flags_environment_with_http_info(environment_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.update_feature_flags_environment"
  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 FeatureFlagsAPI.update_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_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'])
  # 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] || 'EnvironmentResponse'

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

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

#update_saved_filter_attributes(saved_filter_id, body, opts = {}) ⇒ Object

Patch a saved filter.

See Also:



1614
1615
1616
1617
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1614

def update_saved_filter_attributes(saved_filter_id, body, opts = {})
  data, _status_code, _headers = update_saved_filter_attributes_with_http_info(saved_filter_id, body, opts)
  data
end

#update_saved_filter_attributes_with_http_info(saved_filter_id, body, opts = {}) ⇒ Array<(SavedFilterResponse, Integer, Hash)>

Patch a saved filter.

Partially updates a saved filter. Supports both LIST and RULES filters. Supply at least one of name, description, or targeting_rules. Omitted or null fields are preserved. Supplying targeting_rules replaces the entire collection and propagates changes to every feature flag that references the saved filter. Metadata-only updates do not require edit permission or approval on those feature flags. Rule updates require edit permission on all consumer flags and are rejected when approval is required, unless the caller has the feature_flag_approvals_override permission. The optional last_updated_at field detects stale updates. It does not set the update time.

Parameters:

  • saved_filter_id (UUID) —

    The ID of the saved filter.

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

    the optional parameters

Returns:

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

    SavedFilterResponse data, response status code and response headers



1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1634

def update_saved_filter_attributes_with_http_info(saved_filter_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_saved_filter_attributes ...'
  end
  # verify the required parameter 'saved_filter_id' is set
  if @api_client.config.client_side_validation && saved_filter_id.nil?
    fail ArgumentError, "Missing the required parameter 'saved_filter_id' when calling FeatureFlagsAPI.update_saved_filter_attributes"
  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 FeatureFlagsAPI.update_saved_filter_attributes"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/saved-filters/{saved_filter_id}'.sub('{saved_filter_id}', CGI.escape(saved_filter_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'])
  # 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] || 'SavedFilterResponse'

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

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

#update_variant_for_feature_flag(feature_flag_id, variant_id, body, opts = {}) ⇒ Object

Update a variant.

See Also:



1693
1694
1695
1696
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1693

def update_variant_for_feature_flag(feature_flag_id, variant_id, body, opts = {})
  data, _status_code, _headers = update_variant_for_feature_flag_with_http_info(feature_flag_id, variant_id, body, opts)
  data
end

#update_variant_for_feature_flag_with_http_info(feature_flag_id, variant_id, body, opts = {}) ⇒ Array<(Variant, Integer, Hash)>

Update a variant.

Updates the name and value of an existing variant on a feature flag.

When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a FlagSuggestion with 201 Created instead of applying the change immediately. Use the returned suggestion id to approve or reject the change. If a pending suggestion already exists for this flag's variant property, the endpoint returns 409 Conflict.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • variant_id (UUID) —

    The ID of the variant.

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 1709

def update_variant_for_feature_flag_with_http_info(feature_flag_id, variant_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_variant_for_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.update_variant_for_feature_flag"
  end
  # verify the required parameter 'variant_id' is set
  if @api_client.config.client_side_validation && variant_id.nil?
    fail ArgumentError, "Missing the required parameter 'variant_id' when calling FeatureFlagsAPI.update_variant_for_feature_flag"
  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 FeatureFlagsAPI.update_variant_for_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/variants/{variant_id}'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{variant_id}', CGI.escape(variant_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'])
  # 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] || 'Variant'

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

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