Integrations (beta)

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. 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.

Integration configuration is an Enterprise feature

Integration configuration is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

You can use the integrations API to create, delete, and manage integration configurations.

An integration configuration stores and manages configuration details for an integration between LaunchDarkly and a third-party application. To learn more about building an integration, read Using the LaunchDarkly integration framework and Building partner integrations.

Get all configurations for the integration

Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations).

Request
path Parameters
integrationKey
required
string <string>

Integration key

Responses
200

List of Integration Configurations

400

Invalid request

401

Invalid access token

403

Forbidden

404

Integration key not found

429

Rate limited

get/api/v2/integration-configurations/keys/{integrationKey}
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}
Create integration configuration
Create a new integration configuration. (Excludes persistent store and flag import configurations.)


Request 
path Parameters
integrationKey
required
string <string> 
The integration key


 
Request Body schema: application/json
required
name
required
string
The name of the integration configuration


 
enabled
boolean
Whether the integration configuration is enabled. If omitted, defaults to true


 
tags
Array of strings
Tags for the integration


 
required
object
The unique set of fields required to configure the integration. Refer to the formVariables field in the corresponding manifest.json at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure.


 
object (CapabilityConfigPost) 
 
Responses 
201
Integration Configuration response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Integration key not found


409
Status conflict


429
Rate limited


post/api/v2/integration-configurations/keys/{integrationKey}
Request samples 
application/json
{
  • "name": "Example integration configuration",
  • "enabled": true,
  • "tags": [
    ],
  • "configValues": {
    },
  • "capabilityConfig": {
    }
}
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "string",
  • "name": "Example Datadog integration",
  • "_createdAt": 0,
  • "_integrationKey": "datadog",
  • "tags": [
    ],
  • "enabled": true,
  • "_access": {
    },
  • "configValues": {
    },
  • "capabilityConfig": {
    }
}
Get an integration configuration
Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)


Request 
path Parameters
integrationConfigurationId
required
string <string> 
Integration configuration ID


 
Responses 
200
Integration Configuration response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Integration ID not found


429
Rate limited


get/api/v2/integration-configurations/{integrationConfigurationId}
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "string",
  • "name": "Example Datadog integration",
  • "_createdAt": 0,
  • "_integrationKey": "datadog",
  • "tags": [
    ],
  • "enabled": true,
  • "_access": {
    },
  • "configValues": {
    },
  • "capabilityConfig": {
    }
}
Update integration configuration
Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.


Request 
path Parameters
integrationConfigurationId
required
string <string> 
The ID of the integration configuration


 
Request Body schema: application/json
required
 Array 
op
required
string
The type of operation to perform


 
path
required
string
A JSON Pointer string specifying the part of the document to operate on


 
value
any
A JSON value used in "add", "replace", and "test" operations


 
Responses 
200
Integration configuration response


400
Invalid request


403
Forbidden


404
Invalid resource identifier


409
Status conflict


429
Rate limited


patch/api/v2/integration-configurations/{integrationConfigurationId}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "string",
  • "name": "Example Datadog integration",
  • "_createdAt": 0,
  • "_integrationKey": "datadog",
  • "tags": [
    ],
  • "enabled": true,
  • "_access": {
    },
  • "configValues": {
    },
  • "capabilityConfig": {
    }
}
Delete integration configuration
Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)


Request 
path Parameters
integrationConfigurationId
required
string <string> 
The ID of the integration configuration to be deleted


 
Responses 
204
Action succeeded


400
Invalid request


401
Invalid access token


403
Forbidden


404
Invalid resource identifier


429
Rate limited


delete/api/v2/integration-configurations/{integrationConfigurationId}
Request samples 
Response samples 
application/json
{
  • "code": "invalid_request",
  • "message": "Invalid request body"
}
➔ Next to Layers