launchdarkly_project_info – Return a Project or List of Projects

New in version 0.2.11.

Synopsis

  • Return a dictionary of a single LaunchDarkly Project or List of dictionaries containing LaunchDarkly Projects

Parameters

Parameter Choices/Defaults Comments
api_key
string / required
LaunchDarkly API Key. May be set as LAUNCHDARKLY_ACCESS_TOKEN environment variable.
environment_tags
list
list of tags to filter environments within the project. Only environments that contain one of the tags will be returned.
project_key
string
Project key is used to return a single project matching that key.
tags
list
list of tags to filter projects. Only projects that contain one of the tags will be returned

Examples

# Get project based on its key.
- launchdarkly_project_info:
    api_key: api-12345
    project_key: example-project

# Get list of projects that are tagged "dev"
- launchdarkly_project_info:
    api_key: api-12345
    tags:
      - dev

# Get list of projects that are tagged "dev" and only return environments tagged "prod"
- launchdarkly_project_info:
    api_key: api-12345
    tags:
      - dev
    environment_tags:
      - prod

# Get list of all projects only return environments tagged "prod"
- launchdarkly_project_info:
    api_key: api-12345
    environment_tags:
      - prod

Return Values

Common return values are documented here, the following are the fields unique to this :

Key Returned Description
project
dict or list
on success
Dictionary or List of Dictionaries containing a Project



Status

  • This is not guaranteed to have a backwards compatible interface. [preview]

  • This is maintained by the Ansible Community. [community]

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.