Create a flag import configuration

POST

/api/v2/integration-capabilities/flag-import/:projectKey/:integrationKey

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.

Path parameters

projectKeystringRequired

The project key

integrationKeystringRequired

The integration key

Request

This endpoint expects an object.

configmap from strings to anyRequired

The global configuration settings, as specified by the formVariables in the manifest.json for this configuration.

tagslist of stringsOptional

Tags to associate with the configuration

namestringOptional

Name to identify the configuration

Response

Flag Import Configuration response

_linksobject

The location and content type of related resources

_idstring

The integration ID

integrationKeyenum

Allowed values: splitunleash

The integration key

projectKeystring

The project key

configmap from strings to any

The configuration for the given import integration. Only included when requesting a single integration by ID. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration.

tagslist of strings

List of tags for this configuration

namestring

Name of the configuration

versioninteger

Version of the current configuration

_statusobject

Details on the status of the import job

_accessobjectOptional

Details on the allowed and denied actions for this configuration

Errors

POST

1 curl -X POST https://app.launchdarkly.com/api/v2/integration-capabilities/flag-import/projectKey/integrationKey \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "config": {
6     "environmentId": "The ID of the environment in the external system",
7     "ldApiKey": "An API key with create flag permissions in your LaunchDarkly account",
8     "ldMaintainer": "The ID of the member who will be the maintainer of the imported flags",
9     "ldTag": "A tag to apply to all flags imported to LaunchDarkly",
10     "splitTag": "If provided, imports only the flags from the external system with this tag. Leave blank to import all flags.",
11     "workspaceApiKey": "An API key with read permissions in the external feature management system",
12     "workspaceId": "The ID of the workspace in the external system"
13   },
14   "tags": [
15     "example-tag"
16   ],
17   "name": "Sample configuration"
18 }'

200Successful

1 {
2   "_links": {
3     "self": {
4       "href": "href",
5       "type": "type"
6     },
7     "parent": {
8       "href": "href",
9       "type": "type"
10     },
11     "project": {
12       "href": "href",
13       "type": "type"
14     }
15   },
16   "_id": "12ab3c4d5ef1a2345bcde67f",
17   "integrationKey": "split",
18   "projectKey": "default",
19   "config": {
20     "key": "value"
21   },
22   "tags": [
23     "tags"
24   ],
25   "name": "Development environment configuration",
26   "version": 1,
27   "_status": {
28     "status": "complete",
29     "lastImport": 1000000,
30     "lastError": 1000000,
31     "errors": [
32       {}
33     ]
34   },
35   "_access": {
36     "denied": [
37       {
38         "action": "action",
39         "reason": {
40           "effect": "allow"
41         }
42       }
43     ],
44     "allowed": [
45       {
46         "action": "action",
47         "reason": {
48           "effect": "allow"
49         }
50       }
51     ]
52   }
53 }

Delete a flag import configuration

Up Next

Built with

1	curl -X POST https://app.launchdarkly.com/api/v2/integration-capabilities/flag-import/projectKey/integrationKey \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"config": {
6	"environmentId": "The ID of the environment in the external system",
7	"ldApiKey": "An API key with create flag permissions in your LaunchDarkly account",
8	"ldMaintainer": "The ID of the member who will be the maintainer of the imported flags",
9	"ldTag": "A tag to apply to all flags imported to LaunchDarkly",
10	"splitTag": "If provided, imports only the flags from the external system with this tag. Leave blank to import all flags.",
11	"workspaceApiKey": "An API key with read permissions in the external feature management system",
12	"workspaceId": "The ID of the workspace in the external system"
13	},
14	"tags": [
15	"example-tag"
16	],
17	"name": "Sample configuration"
18	}'

1	{
2	"_links": {
3	"self": {
4	"href": "href",
5	"type": "type"
6	},
7	"parent": {
8	"href": "href",
9	"type": "type"
10	},
11	"project": {
12	"href": "href",
13	"type": "type"
14	}
15	},
16	"_id": "12ab3c4d5ef1a2345bcde67f",
17	"integrationKey": "split",
18	"projectKey": "default",
19	"config": {
20	"key": "value"
21	},
22	"tags": [
23	"tags"
24	],
25	"name": "Development environment configuration",
26	"version": 1,
27	"_status": {
28	"status": "complete",
29	"lastImport": 1000000,
30	"lastError": 1000000,
31	"errors": [
32	{}
33	]
34	},
35	"_access": {
36	"denied": [
37	{
38	"action": "action",
39	"reason": {
40	"effect": "allow"
41	}
42	}
43	],
44	"allowed": [
45	{
46	"action": "action",
47	"reason": {
48	"effect": "allow"
49	}
50	}
51	]
52	}
53	}