Create flag link

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Create a new flag link. Flag links let you reference external resources and associate them with your flags.

POST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}

Create flag link

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deepLink": "https://example.com/archives/123123123",
  "description": "Example link description",
  "key": "flag-link-key-123abc",
  "title": "Example link title"
}
'

201

{
  "_links": {},
  "_id": "1234a56b7c89d012345e678f",
  "_deepLink": "https://example.com/archives/123123123",
  "_timestamp": "{\"milliseconds\": 1655342199935, \"seconds\": 1655342199, \"rfc3339\": \"2022-06-16T01:16:39Z\", \"simple\": \"2022-06-16 01:16:39\"}",
  "_createdAt": "1654104600000",
  "_key": "flag-link-key-123abc",
  "_integrationKey": "<string>",
  "title": "Example link title",
  "description": "Example link description",
  "_metadata": {},
  "_member": {
    "_links": {},
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

featureFlagKey · string<string> · required

The feature flag key

Body

application/json

key · string

The flag link key

Example:

"flag-link-key-123abc"

integrationKey · string

The integration key for an integration whose manifest.json includes the flagLink capability, if this is a flag link for an existing integration. Do not include for URL flag links.

timestamp · integer<int64>

The time, in Unix milliseconds, to mark this flag link as associated with the external URL. If omitted, defaults to the creation time of this flag link.

deepLink · string

The URL for the external resource you are linking the flag to

Example:

"https://example.com/archives/123123123"

title · string

The title of the flag link

Example:

"Example link title"

description · string

The description of the flag link

Example:

"Example link description"

metadata · object

The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration's manifest.json file under flagLink.

Show child attributes

Response

201

application/json

Flag link response

_links · object · required

The location and content type of related resources

Show child attributes

_id · string · required

The ID of this flag link

Example:

"1234a56b7c89d012345e678f"

_deepLink · string · required

The URL for the external resource the flag is linked to

Example:

"https://example.com/archives/123123123"

_timestamp · object · required

The time to mark this flag link as associated with the external URL. Defaults to the creation time of the flag link, but can be set to another time during creation.

Show child attributes

Example:

"{\"milliseconds\": 1655342199935, \"seconds\": 1655342199, \"rfc3339\": \"2022-06-16T01:16:39Z\", \"simple\": \"2022-06-16 01:16:39\"}"

_createdAt · integer<int64> · required

Timestamp of when the flag link was created

Example:

"1654104600000"

_key · string

The flag link key

Example:

"flag-link-key-123abc"

_integrationKey · string

The integration key for an integration whose manifest.json includes the flagLink capability, if this is a flag link for an existing integration

title · string

The title of the flag link

Example:

"Example link title"

description · string

The description of the flag link

Example:

"Example link description"

_metadata · object

The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration's manifest.json file under flagLink.

Show child attributes

_member · object

Details on the member associated with this flag link

Show child attributes