This feature is in beta
To use this feature, pass in a header including the
LD-API-Version
key with value set tobeta
. Use this header with each call. To learn more, read Beta resources.Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.
Flag links let you view external mentions of flags from other tools and services. Links to external conversations and references to your flags allow you to collaborate more easily and quickly review relevant flag contexts. To learn more, read Flag links.
You can create custom flag links by associating an external URL with a feature flag. After you create a flag link, it applies across all your environments. You should use caution when you delete a flag link, because it will be deleted from all your environments.
With the flag links API, you can view, create, update, and delete links to flags.
Several of the endpoints in the flag links API require a flag link ID. The flag link ID is returned as part of the Create flag link and List flag links responses. It is the _id
field, or the _id
field of each element in the items
array.
Get a list of all flag links.
Flag link collection response
Invalid access token
Forbidden
Rate limited
{- "items": [
- {
- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_key": "flag-link-key-123abc",
- "_integrationKey": "string",
- "_id": "1234a56b7c89d012345e678f",
- "_timestamp": {
- "milliseconds": 0,
- "seconds": 0,
- "rfc3339": "string",
- "simple": "string"
}, - "title": "Example link title",
- "description": "Example link description",
- "_metadata": {
- "property1": "string",
- "property2": "string"
}, - "_createdAt": 0,
- "_member": {
- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_id": "string",
- "firstName": "string",
- "lastName": "string"
}
}
], - "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}
}
Create a new flag link. Flag links let you reference external resources and associate them with your flags.
Flag link response
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
{- "description": "Example link description",
- "key": "flag-link-key-123abc",
- "title": "Example link title"
}
{- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_key": "flag-link-key-123abc",
- "_integrationKey": "string",
- "_id": "1234a56b7c89d012345e678f",
- "_timestamp": {
- "milliseconds": 0,
- "seconds": 0,
- "rfc3339": "string",
- "simple": "string"
}, - "title": "Example link title",
- "description": "Example link description",
- "_metadata": {
- "property1": "string",
- "property2": "string"
}, - "_createdAt": 0,
- "_member": {
- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_id": "string",
- "firstName": "string",
- "lastName": "string"
}
}
Update a flag link. Updating a flag link uses a JSON patch representation of the desired changes. To learn more, read Updates.
Flag link response
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Status conflict
Rate limited
[- {
- "op": "replace",
- "path": "/title",
- "value": "Updated flag link title"
}
]
{- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_key": "flag-link-key-123abc",
- "_integrationKey": "string",
- "_id": "1234a56b7c89d012345e678f",
- "_timestamp": {
- "milliseconds": 0,
- "seconds": 0,
- "rfc3339": "string",
- "simple": "string"
}, - "title": "Example link title",
- "description": "Example link description",
- "_metadata": {
- "property1": "string",
- "property2": "string"
}, - "_createdAt": 0,
- "_member": {
- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}, - "_id": "string",
- "firstName": "string",
- "lastName": "string"
}
}
Delete a flag link by ID or key.
Action succeeded
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
{- "code": "invalid_request",
- "message": "Invalid request body"
}