LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Integrations (beta)

Create integration configuration

POST
/api/v2/integration-configurations/keys/{integrationKey}

Create a new integration configuration. (Excludes persistent store and flag import configurations.)

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

integrationKey*string

The integration key

Formatstring

Request Body

application/json

name*string

The name of the integration configuration

enabled?boolean

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

tags?array<string>

Tags for the integration

configValues*

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.

capabilityConfig?

The capability configuration for the integration

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/integration-configurations/keys/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Example integration configuration",    "configValues": {      "optional": "an optional property",      "required": "the required property",      "url": "https://example.com"    }  }'
{  "_links": {    "property1": {      "href": "string",      "type": "string"    },    "property2": {      "href": "string",      "type": "string"    }  },  "_id": "string",  "name": "Example Datadog integration",  "_createdAt": 0,  "_integrationKey": "datadog",  "tags": [    "testing"  ],  "enabled": true,  "_access": {    "denied": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ],    "allowed": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ]  },  "configValues": {    "property1": null,    "property2": null  },  "capabilityConfig": "{\"auditLogEventsHook\": \"statements\": []\"}",  "snowflakeSetupScript": "string",  "redshiftSetupScripts": [    "string"  ],  "redshiftIAMPermissionsPolicy": "string",  "redshiftIAMTrustPolicy": "string",  "_maintainerId": "string"}

Get all configurations for the integration GET

Get all integration configurations with the specified integration key. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).).

Get an integration configuration GET

Get integration configuration with the specified ID. (Excludes [persistent store](https://launchdarkly.com/docs/api/persistent-store-integrations-beta) and [flag import configurations](https://launchdarkly.com/docs/api/flag-import-configurations-beta).)