Create flag link

POST

/api/v2/flag-links/projects/:projectKey/flags/:featureFlagKey

POST

/api/v2/flag-links/projects/:projectKey/flags/:featureFlagKey

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

1 {
2   "_links": {},
3   "_id": "1234a56b7c89d012345e678f",
4   "_deepLink": "https://example.com/archives/123123123",
5   "_timestamp": {},
6   "_createdAt": 1654104600000,
7   "_key": "flag-link-key-123abc",
8   "_integrationKey": "string",
9   "title": "Example link title",
10   "description": "Example link description",
11   "_metadata": {},
12   "_member": {
13     "_links": {},
14     "_id": "string",
15     "firstName": "string",
16     "lastName": "string"
17   }
18 }

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

featureFlagKeystringRequiredformat: "string"

The feature flag key

Request

This endpoint expects an object.

keystringOptional

The flag link key

integrationKeystringOptional

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.

timestamplongOptional

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.

deepLinkstringOptional

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

titlestringOptional

The title of the flag link

descriptionstringOptional

The description of the flag link

metadatamap from strings to stringsOptional

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.

Response

Flag link response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The ID of this flag link

_deepLinkstring

The URL for the external resource the flag is linked to

_timestampobject

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.

_createdAtlong

Timestamp of when the flag link was created

_keystring

The flag link key

_integrationKeystring

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

titlestring

The title of the flag link

descriptionstring

The description of the flag link

_metadatamap from strings to strings

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.

_memberobject

Details on the member associated with this flag link

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error