List feature flags

GET https://api.ap1.datadoghq.com/api/v2/feature-flagshttps://api.ap2.datadoghq.com/api/v2/feature-flagshttps://api.datadoghq.eu/api/v2/feature-flagshttps://api.ddog-gov.com/api/v2/feature-flagshttps://api.us2.ddog-gov.com/api/v2/feature-flagshttps://api.datadoghq.com/api/v2/feature-flagshttps://api.us3.datadoghq.com/api/v2/feature-flagshttps://api.us5.datadoghq.com/api/v2/feature-flags

Overview

Returns a list of feature flags for the organization. Supports filtering by key and archived status. This endpoint requires all of the following permissions:

  • feature_flag_config_read
  • feature_flag_environment_config_read

  • Arguments

    Query Strings

    Name

    Type

    Description

    key

    string

    Filter feature flags by key (partial matching).

    is_archived

    boolean

    Filter by archived status.

    limit

    integer

    Maximum number of results to return.

    offset

    integer

    Number of results to skip.

    Response

    OK

    Response containing a list of feature flags.

    Expand All

    Field

    Type

    Description

    data [required]

    [object]

    List of feature flags.

    attributes [required]

    object

    Attributes of a feature flag in list responses.

    archived_at

    date-time

    The timestamp when the feature flag was archived.

    created_at

    date-time

    The timestamp when the feature flag was created.

    created_by

    uuid

    The ID of the user who created the feature flag.

    description [required]

    string

    The description of the feature flag.

    distribution_channel

    string

    Distribution channel for the feature flag.

    feature_flag_environments

    [object]

    Environment-specific settings for the feature flag.

    default_allocation_key

    string

    The allocation key used for the default variant.

    default_variant_id

    string

    The ID of the default variant for this environment.

    environment_id [required]

    uuid

    The ID of the environment.

    environment_name

    string

    The name of the environment.

    environment_queries

    [string]

    Queries that target this environment.

    is_production

    boolean

    Indicates whether the environment is production.

    override_allocation_key

    string

    The allocation key used for the override variant.

    override_variant_id

    string

    The ID of the override variant for this environment.

    pending_suggestion_id

    string

    Pending suggestion identifier, if approval is required.

    require_feature_flag_approval

    boolean

    Indicates whether feature flag changes require approval in this environment.

    status [required]

    enum

    The status of a feature flag in an environment. Allowed enum values: ENABLED,DISABLED

    json_schema

    string

    JSON schema for validation when value_type is JSON.

    key [required]

    string

    The unique key of the feature flag.

    last_updated_by

    uuid

    The ID of the user who last updated the feature flag.

    name [required]

    string

    The name of the feature flag.

    require_approval

    boolean

    Indicates whether this feature flag requires approval for changes.

    staleness_status

    string

    Indicates the staleness status of the feature flag.

    tags

    [string]

    Tags associated with the feature flag.

    updated_at

    date-time

    The timestamp when the feature flag was last updated.

    value_type [required]

    enum

    The type of values for the feature flag variants. Allowed enum values: BOOLEAN,INTEGER,NUMERIC,STRING,JSON

    variants [required]

    [object]

    The variants of the feature flag.

    created_at

    date-time

    The timestamp when the variant was created.

    id [required]

    uuid

    The unique identifier of the variant.

    key [required]

    string

    The unique key of the variant.

    name [required]

    string

    The name of the variant.

    updated_at

    date-time

    The timestamp when the variant was last updated.

    value [required]

    string

    The value of the variant as a string.

    id [required]

    uuid

    The unique identifier of the feature flag.

    type [required]

    enum

    The resource type. Allowed enum values: feature-flags

    meta

    object

    Pagination metadata for feature flags.

    page

    object

    Pagination metadata for feature flags list responses.

    total_count

    int64

    Total number of items.

    total_filtered_count

    int64

    Total number of items matching the filter.

    {
      "data": [
        {
          "attributes": {
            "archived_at": "2023-01-01T00:00:00Z",
            "created_at": "2023-01-01T00:00:00Z",
            "created_by": "550e8400-e29b-41d4-a716-446655440010",
            "description": "This is an example feature flag for demonstration",
            "distribution_channel": "ALL",
            "feature_flag_environments": [
              {
                "default_allocation_key": "allocation-default-123abc",
                "default_variant_id": "550e8400-e29b-41d4-a716-446655440002",
                "environment_id": "550e8400-e29b-41d4-a716-446655440001",
                "environment_name": "env-search-term",
                "environment_queries": [
                  "test-feature-flag",
                  "env-search-term"
                ],
                "is_production": false,
                "override_allocation_key": "allocation-override-123abc",
                "override_variant_id": "550e8400-e29b-41d4-a716-446655440003",
                "pending_suggestion_id": "550e8400-e29b-41d4-a716-446655440099",
                "require_feature_flag_approval": false,
                "status": "ENABLED"
              }
            ],
            "json_schema": "{\"type\": \"object\", \"properties\": {\"enabled\": {\"type\": \"boolean\"}}}",
            "key": "feature-flag-abc123",
            "last_updated_by": "550e8400-e29b-41d4-a716-446655440010",
            "name": "Feature Flag ABC123",
            "require_approval": false,
            "staleness_status": "ACTIVE",
            "tags": [
              []
            ],
            "updated_at": "2023-01-01T00:00:00Z",
            "value_type": "BOOLEAN",
            "variants": [
              {
                "created_at": "2023-01-01T00:00:00Z",
                "id": "550e8400-e29b-41d4-a716-446655440002",
                "key": "variant-abc123",
                "name": "Variant ABC123",
                "updated_at": "2023-01-01T00:00:00Z",
                "value": "true"
              }
            ]
          },
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "type": "feature-flags"
        }
      ],
      "meta": {
        "page": {
          "total_count": 100,
          "total_filtered_count": 25
        }
      }
    }

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                      # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/feature-flags" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
    """
    List feature flags returns "OK" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
    
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api_instance = FeatureFlagsApi(api_client)
        response = api_instance.list_feature_flags(
            limit=10,
        )
    
        print(response)
    

    Instructions

    First install the library and its dependencies and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # List feature flags returns "OK" response
    
    require "datadog_api_client"
    api_instance = DatadogAPIClient::V2::FeatureFlagsAPI.new
    opts = {
      limit: 10,
    }
    p api_instance.list_feature_flags(opts)
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // List feature flags returns "OK" response
    
    package main
    
    import (
    	"context"
    	"encoding/json"
    	"fmt"
    	"os"
    
    	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
    	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
    )
    
    func main() {
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewFeatureFlagsApi(apiClient)
    	resp, r, err := api.ListFeatureFlags(ctx, *datadogV2.NewListFeatureFlagsOptionalParameters().WithLimit(10))
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `FeatureFlagsApi.ListFeatureFlags`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    
    	responseContent, _ := json.MarshalIndent(resp, "", "  ")
    	fmt.Fprintf(os.Stdout, "Response from `FeatureFlagsApi.ListFeatureFlags`:\n%s\n", responseContent)
    }
    

    Instructions

    First install the library and its dependencies and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // List feature flags returns "OK" response
    
    import com.datadog.api.client.ApiClient;
    import com.datadog.api.client.ApiException;
    import com.datadog.api.client.v2.api.FeatureFlagsApi;
    import com.datadog.api.client.v2.api.FeatureFlagsApi.ListFeatureFlagsOptionalParameters;
    import com.datadog.api.client.v2.model.ListFeatureFlagsResponse;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);
    
        try {
          ListFeatureFlagsResponse result =
              apiInstance.listFeatureFlags(new ListFeatureFlagsOptionalParameters().limit(10));
          System.out.println(result);
        } catch (ApiException e) {
          System.err.println("Exception when calling FeatureFlagsApi#listFeatureFlags");
          System.err.println("Status code: " + e.getCode());
          System.err.println("Reason: " + e.getResponseBody());
          System.err.println("Response headers: " + e.getResponseHeaders());
          e.printStackTrace();
        }
      }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    // List feature flags returns "OK" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_feature_flags::FeatureFlagsAPI;
    use datadog_api_client::datadogV2::api_feature_flags::ListFeatureFlagsOptionalParams;
    
    #[tokio::main]
    async fn main() {
        let configuration = datadog::Configuration::new();
        let api = FeatureFlagsAPI::with_config(configuration);
        let resp = api
            .list_feature_flags(ListFeatureFlagsOptionalParams::default().limit(10))
            .await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * List feature flags returns "OK" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    const apiInstance = new v2.FeatureFlagsApi(configuration);
    
    const params: v2.FeatureFlagsApiListFeatureFlagsRequest = {
      limit: 10,
    };
    
    apiInstance
      .listFeatureFlags(params)
      .then((data: v2.ListFeatureFlagsResponse) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    

    Instructions

    First install the library and its dependencies and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"