Skip to content

FeatureFlagsBetaApi.md

Latest commit

 

History

History
128 lines (87 loc) · 4.72 KB

FeatureFlagsBetaApi.md

File metadata and controls

128 lines (87 loc) · 4.72 KB

FeatureFlagsBetaApi

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

Method HTTP request Description
getDependentFlags GET /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags List dependent feature flags
getDependentFlagsByEnv GET /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags List dependent feature flags by environment

getDependentFlags

MultiEnvironmentDependentFlags getDependentFlags()

Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales. List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read Flag prerequisites.

Example

import {
    FeatureFlagsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FeatureFlagsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let featureFlagKey: string; //The feature flag key (default to undefined)

const { status, data } = await apiInstance.getDependentFlags(
    projectKey,
    featureFlagKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
featureFlagKey [string] The feature flag key defaults to undefined

Return type

MultiEnvironmentDependentFlags

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Multi environment dependent flags collection response -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getDependentFlagsByEnv

DependentFlagsByEnvironment getDependentFlagsByEnv()

Flag prerequisites is an Enterprise feature > > Flag prerequisites is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales. List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite. To learn more, read Flag prerequisites.

Example

import {
    FeatureFlagsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FeatureFlagsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (default to undefined)
let featureFlagKey: string; //The feature flag key (default to undefined)

const { status, data } = await apiInstance.getDependentFlagsByEnv(
    projectKey,
    environmentKey,
    featureFlagKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
environmentKey [string] The environment key defaults to undefined
featureFlagKey [string] The feature flag key defaults to undefined

Return type

DependentFlagsByEnvironment

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Dependent flags collection response -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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