> ## Documentation Index
> Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Create flag link
> > For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).
Create a new flag link. Flag links let you reference external resources and associate them with your flags.
## OpenAPI
````yaml /openapi/launchdarkly-api.json post /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}
openapi: 3.0.3
info:
title: LaunchDarkly REST API
description: >
> For the complete documentation index, see
https://launchdarkly-preview.mintlify.app/llms.txt.
> For the full documentation snapshot, see
https://launchdarkly-preview.mintlify.app/llms-full.txt.
This is the LaunchDarkly REST API. It lets you build custom integrations,
automate your workflow, and manage feature flags and other LaunchDarkly
resources programmatically.
For authentication, rate limits, pagination, versioning, JSON Patch and
semantic patches, beta resources, and the full SDK End-of-Life table, read
the [REST API overview](https://launchdarkly-preview.mintlify.app/api).
To fetch the complete OpenAPI spec, use [Get OpenAPI
spec](https://launchdarkly.com/docs/api/other/get-openapi-spec).
contact:
name: LaunchDarkly Technical Support Team
url: https://support.launchdarkly.com
email: support@launchdarkly.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2.0'
servers:
- url: https://app.launchdarkly.com
description: ' Default'
- url: https://app.launchdarkly.us
description: ' Federal'
security:
- ApiKey:
- read
- write
tags:
- name: Access tokens
description: >-
The access tokens API allows you to list, create, modify, and delete
access tokens programmatically.
- name: Account members
description: >-
The account members API allows you to invite new members to an account by
making a `POST` request to `/api/v2/members`. When you invite a new member
to an account, an invitation is sent to the email you provided.
- name: Account usage (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: AI Configs
description: >-
The AI Configs API allows you to create, retrieve, and edit AI Configs, AI
Config variations, and AI model configurations.
- name: Announcements
description: >-
The announcements API lets you create and update a custom announcement
banner that appears in the LaunchDarkly user interface for everyone in
your organization.
- name: Applications (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Approvals
description: >-
An account member can request approval on changes to a flag or AI Config's
targeting or variations, or to a segment's targeting. Members may be
required to request approval depending on the settings in their
LaunchDarkly project.
- name: Approvals (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Audit log
description: >-
LaunchDarkly maintains a record of all the changes made to any resource in
the system. You can access this history using the audit log API, including
filtering by timestamps, or using a custom policy to select which entries
to receive.
- name: Code references
description: >-
> ### Code references is an Enterprise feature > > Code references is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Context settings
description: >-
You can use the context settings API to assign a context to a specific
variation for any feature flag. To learn more, read [View and manage
contexts](https://launchdarkly.com/docs/home/observability/context-attributes#view-and-manage-contexts).
- name: Contexts
description: >-
Contexts are people, services, machines, or other resources that encounter
feature flags in your product. Contexts are identified by their `kind`,
which describes the type of resources encountering flags, and by their
`key`.
- name: Custom roles
description: >-
> ### Custom roles is an Enterprise feature > > Custom roles is available
to customers on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Data Export destinations
description: >-
> ### Data Export is an add-on feature > > Data Export is available as an
add-on for customers on a Foundation or Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Environments
description: >-
Environments allow you to maintain separate rollout rules in different
contexts, from local development to QA, staging, and production. With the
LaunchDarkly Environments API, you can programmatically list, create, and
manage environments.
- name: Experiments
description: >-
> ### Available for subscription customers > > Experimentation is
available to all customers on a Developer, Foundation, or Enterprise
subscription. If you're on an older Pro or Enterprise plan,
Experimentation is available as an add-on.
- name: Feature flags
description: >-
The feature flags API allows you to list, create, and modify feature flags
and their targeting. For example, you can control percentage rollouts,
target specific contexts, or even toggle off a feature flag
programmatically.
- name: Feature flags (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag import configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag links (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag triggers
description: >-
> ### Flag triggers is an Enterprise feature > > Flag triggers is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Follow flags
description: >-
Follow flags to receive email updates about targeting changes to a flag in
a project and environment.
- name: Holdouts (beta)
description: >-
> ### Available for customers using Experimentation > > Holdouts are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Insights charts (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights deployments (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights flag events (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights pull requests (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights repositories (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights scores (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integration audit log subscriptions
description: >-
Audit log integration subscriptions allow you to send audit log events
hooks to one of dozens of external tools. For example, you can send flag
change event webhooks to external third party software.
- name: Integration delivery configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Layers
description: >-
> ### Available for customers using Experimentation > > Layers are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Metrics
description: >-
Metrics track flag behavior over time when an experiment is running. The
data generated from experiments gives you more insight into the impact of
a particular flag.
- name: Metrics (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: OAuth2 Clients
description: >-
The OAuth2 client API allows you to register a LaunchDarkly OAuth client
for use in your own custom integrations.
- name: Persistent store integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Projects
description: >-
Projects allow you to manage multiple different software projects under
one LaunchDarkly account. Each project has its own unique set of
environments and feature flags.
- name: Relay Proxy configurations
description: >-
> ### Relay Proxy automatic configuration is an Enterprise feature > >
Relay Proxy automatic configuration is available to customers on an
Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Release pipelines (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Release policies (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Releases (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Scheduled changes
description: >-
> ### Scheduled flag changes is an Enterprise feature > > Scheduled flag
changes is available to customers on an Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Segments
description: >-
> ### Synced segments and larger list-based segments are an Enterprise
feature > > This section documents endpoints for rule-based, list-based,
and synced segments.
- name: Tags
description: >-
Tags are simple strings that you can attach to most resources in
LaunchDarkly. Tags are useful for grouping resources into a set that you
can name in a resource specifier.
- name: Teams
description: >-
> ### Teams is an Enterprise feature > > Teams is available to customers
on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Teams (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: User settings
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of the user
settings API.
- name: Users
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Users (beta)
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Views (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Webhooks
description: >-
The webhooks API lets you build your own integrations that subscribe to
activities in LaunchDarkly. When you generate an activity in LaunchDarkly,
such as when you change a flag or you create a project, LaunchDarkly sends
an HTTP POST payload to the...
- name: Workflow templates
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Workflows
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Other
description: Other requests available in the LaunchDarkly API.
paths:
/api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}:
post:
tags:
- Flag links (beta)
summary: Create flag link
description: >-
> For the complete documentation index, see
[llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the
full documentation snapshot, see
[llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).
Create a new flag link. Flag links let you reference external resources
and associate them with your flags.
operationId: createFlagLink
parameters:
- name: projectKey
in: path
description: The project key
required: true
schema:
type: string
format: string
description: The project key
- name: featureFlagKey
in: path
description: The feature flag key
required: true
schema:
type: string
format: string
description: The feature flag key
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/flagLinkPost'
example:
deepLink: https://example.com/archives/123123123
description: Example link description
key: flag-link-key-123abc
title: Example link title
required: true
responses:
'201':
description: Flag link response
content:
application/json:
schema:
$ref: '#/components/schemas/FlagLinkRep'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestErrorRep'
'401':
description: Invalid access token
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorRep'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorRep'
'404':
description: Invalid resource identifier
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorRep'
'429':
description: Rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitedErrorRep'
components:
schemas:
flagLinkPost:
type: object
properties:
key:
type: string
description: The flag link key
example: flag-link-key-123abc
integrationKey:
type: string
description: >-
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:
$ref: '#/components/schemas/UnixMillis'
description: >-
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:
type: string
description: The URL for the external resource you are linking the flag to
example: https://example.com/archives/123123123
title:
type: string
description: The title of the flag link
example: Example link title
description:
type: string
description: The description of the flag link
example: Example link description
metadata:
type: object
additionalProperties:
type: string
description: >-
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.
FlagLinkRep:
type: object
required:
- _links
- _id
- _deepLink
- _timestamp
- _createdAt
properties:
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
_key:
type: string
description: The flag link key
example: flag-link-key-123abc
_integrationKey:
type: string
description: >-
The integration key for an integration whose
manifest.json includes the flagLink
capability, if this is a flag link for an existing integration
_id:
type: string
description: The ID of this flag link
example: 1234a56b7c89d012345e678f
_deepLink:
type: string
description: The URL for the external resource the flag is linked to
example: https://example.com/archives/123123123
_timestamp:
$ref: '#/components/schemas/TimestampRep'
description: >-
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.
example: >-
{"milliseconds": 1655342199935, "seconds": 1655342199, "rfc3339":
"2022-06-16T01:16:39Z", "simple": "2022-06-16 01:16:39"}
title:
type: string
description: The title of the flag link
example: Example link title
description:
type: string
description: The description of the flag link
example: Example link description
_metadata:
type: object
additionalProperties:
type: string
description: >-
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.
_createdAt:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of when the flag link was created
example: '1654104600000'
_member:
$ref: '#/components/schemas/FlagLinkMember'
description: Details on the member associated with this flag link
InvalidRequestErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: invalid_request
message:
type: string
description: Description of the error
example: Invalid request body
UnauthorizedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: unauthorized
message:
type: string
description: Description of the error
example: Invalid access token
ForbiddenErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: forbidden
message:
type: string
description: Description of the error
example: Forbidden. Access to the requested resource was denied.
NotFoundErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: not_found
message:
type: string
description: Description of the error
example: Invalid resource identifier
RateLimitedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: rate_limited
message:
type: string
description: Description of the error
example: You've exceeded the API rate limit. Try again later.
UnixMillis:
type: integer
format: int64
Link:
type: object
properties:
href:
type: string
type:
type: string
TimestampRep:
type: object
properties:
milliseconds:
$ref: '#/components/schemas/UnixMillis'
seconds:
type: integer
format: int64
rfc3339:
type: string
simple:
type: string
FlagLinkMember:
type: object
required:
- _links
- _id
properties:
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
_id:
type: string
firstName:
type: string
lastName:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: Authorization
````