Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 2.94 KB

TagsApi.md

File metadata and controls

91 lines (67 loc) · 2.94 KB

LaunchDarklyApi::TagsApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
get_tags GET /api/v2/tags List tags

get_tags

get_tags(opts)

List tags

Get a list of tags.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::TagsApi.new
opts = {
  kind: ['inner_example'], # Array<String> | Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default.
  pre: 'pre_example', # String | Return tags with the specified prefix
  archived: true, # Boolean | Whether or not to return archived flags
  limit: 56, # Integer | The number of tags to return. Maximum is 1000.
  offset: 56, # Integer | The index of the first tag to return. Default is 0.
  as_of: 'as_of_example' # String | The time to retrieve tags as of. Default is the current time.
}

begin
  # List tags
  result = api_instance.get_tags(opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling TagsApi->get_tags: #{e}"
end

Using the get_tags_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_tags_with_http_info(opts)

begin
  # List tags
  data, status_code, headers = api_instance.get_tags_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TagsCollection>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling TagsApi->get_tags_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
kind Array<String> Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`. Returns all types by default. [optional]
pre String Return tags with the specified prefix [optional]
archived Boolean Whether or not to return archived flags [optional]
limit Integer The number of tags to return. Maximum is 1000. [optional]
offset Integer The index of the first tag to return. Default is 0. [optional]
as_of String The time to retrieve tags as of. Default is the current time. [optional]

Return type

TagsCollection

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json