Create integration configuration

POST

/api/v2/integration-configurations/keys/:integrationKey

POST

/api/v2/integration-configurations/keys/:integrationKey

curl -X POST https://app.launchdarkly.com/api/v2/integration-configurations/keys/integrationKey \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Example integration configuration",
  "configValues": {
    "optional": "an optional property",
    "required": "the required property",
    "url": "https://example.com"
  }
}'

{
  "_links": {},
  "_id": "string",
  "name": "Example Datadog integration",
  "_createdAt": 1,
  "_integrationKey": "datadog",
  "tags": [
    "testing"
  ],
  "enabled": true,
  "_access": {
    "denied": [
      {
        "action": "string",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ],
          "role_name": "string"
        }
      }
    ],
    "allowed": [
      {
        "action": "string",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ],
          "role_name": "string"
        }
      }
    ]
  },
  "configValues": {},
  "capabilityConfig": {},
  "snowflakeSetupScript": "string",
  "redshiftSetupScripts": [
    "string"
  ],
  "redshiftIAMPermissionsPolicy": "string",
  "redshiftIAMTrustPolicy": "string",
  "_maintainerId": "string"
}

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

Create a new integration configuration. (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).)

Authentication

Authorizationstring

API Key authentication via header

Path parameters

integrationKeystringRequiredformat: "string"

The integration key

Request

This endpoint expects an object.

namestringRequired

The name of the integration configuration

configValuesmap from strings to anyRequired

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.

enabledbooleanOptional

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

tagslist of stringsOptional

Tags for the integration

capabilityConfigobjectOptional

The capability configuration for the integration

Response

Integration Configuration response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The unique identifier for this integration configuration

namestring

A human-friendly name for the integration

_createdAtlongOptional

The time the integration configuration was created

_integrationKeystringOptional

The type of integration

tagslist of stringsOptional

An array of tags for this integration

enabledbooleanOptional

Whether the integration is currently active

_accessobjectOptional

Details on the allowed and denied actions for this integration configuration

configValuesmap from strings to anyOptional

Details on configuration for an integration of this type. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration.

capabilityConfigobjectOptional

The capability configuration for the integration

snowflakeSetupScriptstringOptional

Consolidated SQL script for Snowflake Warehouse Native Experimentation setup. Present only for setup endpoint responses.

redshiftSetupScriptslist of stringsOptional

SQL setup scripts (4 parts) for Redshift native Experimentation setup. Present on setup endpoint responses and, rehydrated from the persisted config, on active (finalized) Redshift native Experimentation configurations.

redshiftIAMPermissionsPolicystringOptional

IAM permissions policy JSON for the customer's Redshift IAM role. Present only for setup endpoint responses.

redshiftIAMTrustPolicystringOptional

IAM trust policy JSON for the customer's Redshift IAM role. Present only for setup endpoint responses.

_maintainerIdstringOptional

The ID of the member who maintains this integration configuration. Defaults to the member who created it.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error