Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 4.05 KB

TagsApi.md

File metadata and controls

103 lines (73 loc) · 4.05 KB

launchdarkly_api.TagsApi

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

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

get_tags

TagsCollection get_tags(kind=kind, pre=pre, archived=archived, limit=limit, offset=offset, as_of=as_of)

List tags

Get a list of tags.

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.tags_collection import TagsCollection
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.TagsApi(api_client)
    kind = ['kind_example'] # List[str] | Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `metric-data-source`, `aiconfig`, and `view`. Returns all types by default. (optional)
    pre = 'pre_example' # str | Return tags with the specified prefix (optional)
    archived = True # bool | Whether or not to return archived flags (optional)
    limit = 56 # int | The number of tags to return. Maximum is 1000. (optional)
    offset = 56 # int | The index of the first tag to return. Default is 0. (optional)
    as_of = 'as_of_example' # str | The time to retrieve tags as of. Default is the current time. (optional)

    try:
        # List tags
        api_response = api_instance.get_tags(kind=kind, pre=pre, archived=archived, limit=limit, offset=offset, as_of=as_of)
        print("The response of TagsApi->get_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TagsApi->get_tags: %s\n" % e)

Parameters

Name Type Description Notes
kind List[str] Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`, `metric`, `metric-data-source`, `aiconfig`, and `view`. Returns all types by default. [optional]
pre str Return tags with the specified prefix [optional]
archived bool Whether or not to return archived flags [optional]
limit int The number of tags to return. Maximum is 1000. [optional]
offset int The index of the first tag to return. Default is 0. [optional]
as_of str 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

HTTP response details

Status code Description Response headers
200 Tag collection response -
400 Bad request -
401 Invalid access token -
403 Forbidden -
429 Rate Limited -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]