Flag import configurations (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.

Flag import configurations allow you to import feature flags from another feature management system.

Use the flag import configuration endpoints to create, delete, and manage flag import configurations. You can import flags from other feature management tools into LaunchDarkly. For example, you can import flags from Split.io.

Several of the endpoints in the flag import configuration API require an integration ID. The integration ID is returned as part of the Create a flag import configuration response, in the _id field. It is also returned as part of the List all flag import configurations response, in the _id field of each element in the items array.

To learn more about flag import configurations, read Import flags.

List all flag import configurations

List all flag import configurations.

Responses
200

Flag Import Configuration response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Project not found

409

Status conflict

429

Rate limited

get/api/v2/integration-capabilities/flag-import
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}
Create a flag import configuration
Create a new flag import configuration. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split. The config object in the request body schema is described by the global integration settings, as specified by the formVariables in the manifest.json for this integration. It varies slightly based on the integrationKey.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
integrationKey
required
string <string> 
The integration key


 
Request Body schema: application/json
required
required
object (FormVariableConfig) 
 
tags
Array of strings
Tags to associate with the configuration


 
name
string
Name to identify the configuration


 
Responses 
200
Flag Import Configuration response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Project not found


409
Status conflict


429
Rate limited


post/api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}
Request samples 
application/json
{
  • "config": {
    },
  • "name": "Sample configuration",
  • "tags": [
    ]
}
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "split",
  • "projectKey": "default",
  • "config": {
    },
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    },
  • "_status": {
    }
}
Get a single flag import configuration
Get a single flag import configuration by ID. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
integrationKey
required
string <string> 
The integration key, for example, split


 
integrationId
required
string <string> 
The integration ID


 
Responses 
200
Flag import response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Project or import configuration not found


409
Status conflict


429
Rate limited


get/api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "split",
  • "projectKey": "default",
  • "config": {
    },
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    },
  • "_status": {
    }
}
Update a flag import configuration
Updating a flag import configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

To add an element to the import configuration fields that are arrays, set the path to the name of the field and then append /<array index>. Use /0 to add to the beginning of the array. Use /- to add to the end of the array.

You can update the config, tags, and name of the flag import configuration.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
integrationKey
required
string <string> 
The integration key


 
integrationId
required
string <string> 
The integration ID


 
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
Flag import response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Project or import configuration not found


409
Status conflict


429
Rate limited


patch/api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "split",
  • "projectKey": "default",
  • "config": {
    },
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    },
  • "_status": {
    }
}
Delete a flag import configuration
Delete a flag import configuration by ID. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
integrationKey
required
string <string> 
The integration key


 
integrationId
required
string <string> 
The integration ID


 
Responses 
204
Action completed successfully


401
Invalid access token


403
Forbidden


404
Project or import configuration not found


409
Status conflict


429
Rate limited


delete/api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}
Request samples 
Response samples 
application/json
{
  • "code": "unauthorized",
  • "message": "Invalid access token"
}
Trigger a single flag import run
Trigger a single flag import run for an existing flag import configuration. The integrationKey path parameter identifies the feature management system from which the import occurs, for example, split.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
integrationKey
required
string <string> 
The integration key


 
integrationId
required
string <string> 
The integration ID


 
Responses 
201
400
Invalid request


401
Invalid access token


403
Forbidden


404
Project or import configuration not found


409
Status conflict


429
Rate limited


post/api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger
Request samples 
Response samples 
application/json
{
  • "Name": "string",
  • "Kind": "string",
  • "PkgPath": "string",
  • "PkgName": "string",
  • "ValidPos": true,
  • "Shadow": {
    }
}
➔ Next to Flag links (beta)