FlagImportConfigurationsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
createFlagImportConfiguration	POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}	Create a flag import configuration
deleteFlagImportConfiguration	DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}	Delete a flag import configuration
getFlagImportConfiguration	GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}	Get a single flag import configuration
getFlagImportConfigurations	GET /api/v2/integration-capabilities/flag-import	List all flag import configurations
patchFlagImportConfiguration	PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}	Update a flag import configuration
triggerFlagImportJob	POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger	Trigger a single flag import run

createFlagImportConfiguration

FlagImportIntegration createFlagImportConfiguration(projectKey, integrationKey, flagImportConfigurationPost)

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 <code>formVariables</code> in the <code>manifest.json</code> for this integration. It varies slightly based on the `integrationKey`.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String integrationKey = "integrationKey_example"; // String | The integration key
    FlagImportConfigurationPost flagImportConfigurationPost = new FlagImportConfigurationPost(); // FlagImportConfigurationPost | 
    try {
      FlagImportIntegration result = apiInstance.createFlagImportConfiguration(projectKey, integrationKey, flagImportConfigurationPost);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#createFlagImportConfiguration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
integrationKey	String	The integration key
flagImportConfigurationPost	FlagImportConfigurationPost

Return type

FlagImportIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Flag Import Configuration response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Project not found	-
409	Status conflict	-
429	Rate limited	-

deleteFlagImportConfiguration

deleteFlagImportConfiguration(projectKey, integrationKey, integrationId)

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

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String integrationKey = "integrationKey_example"; // String | The integration key
    String integrationId = "integrationId_example"; // String | The integration ID
    try {
      apiInstance.deleteFlagImportConfiguration(projectKey, integrationKey, integrationId);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#deleteFlagImportConfiguration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
integrationKey	String	The integration key
integrationId	String	The integration ID

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Action completed successfully	-
401	Invalid access token	-
403	Forbidden	-
404	Project or import configuration not found	-
409	Status conflict	-
429	Rate limited	-

getFlagImportConfiguration

FlagImportIntegration getFlagImportConfiguration(projectKey, integrationKey, integrationId)

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

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String integrationKey = "integrationKey_example"; // String | The integration key, for example, `split`
    String integrationId = "integrationId_example"; // String | The integration ID
    try {
      FlagImportIntegration result = apiInstance.getFlagImportConfiguration(projectKey, integrationKey, integrationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#getFlagImportConfiguration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
integrationKey	String	The integration key, for example, `split`
integrationId	String	The integration ID

Return type

FlagImportIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
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	-

getFlagImportConfigurations

FlagImportIntegrationCollection getFlagImportConfigurations()

List all flag import configurations

List all flag import configurations.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    try {
      FlagImportIntegrationCollection result = apiInstance.getFlagImportConfigurations();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#getFlagImportConfigurations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

FlagImportIntegrationCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Flag Import Configuration response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Project not found	-
409	Status conflict	-
429	Rate limited	-

patchFlagImportConfiguration

FlagImportIntegration patchFlagImportConfiguration(projectKey, integrationKey, integrationId, patchOperation)

Update a flag import configuration

Updating a flag import configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.<br/><br/>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.<br/><br/>You can update the `config`, `tags`, and `name` of the flag import configuration.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String integrationKey = "integrationKey_example"; // String | The integration key
    String integrationId = "integrationId_example"; // String | The integration ID
    List<PatchOperation> patchOperation = Arrays.asList(); // List<PatchOperation> | 
    try {
      FlagImportIntegration result = apiInstance.patchFlagImportConfiguration(projectKey, integrationKey, integrationId, patchOperation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#patchFlagImportConfiguration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
integrationKey	String	The integration key
integrationId	String	The integration ID
patchOperation	List<PatchOperation>

Return type

FlagImportIntegration

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
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	-

triggerFlagImportJob

triggerFlagImportJob(projectKey, integrationKey, integrationId)

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

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.FlagImportConfigurationsBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    FlagImportConfigurationsBetaApi apiInstance = new FlagImportConfigurationsBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String integrationKey = "integrationKey_example"; // String | The integration key
    String integrationId = "integrationId_example"; // String | The integration ID
    try {
      apiInstance.triggerFlagImportJob(projectKey, integrationKey, integrationId);
    } catch (ApiException e) {
      System.err.println("Exception when calling FlagImportConfigurationsBetaApi#triggerFlagImportJob");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
projectKey	String	The project key
integrationKey	String	The integration key
integrationId	String	The integration ID

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Import job queued successfully	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Project or import configuration not found	-
409	Status conflict	-
429	Rate limited	-

Files

FlagImportConfigurationsBetaApi.md

Latest commit

History

FlagImportConfigurationsBetaApi.md

File metadata and controls

FlagImportConfigurationsBetaApi

createFlagImportConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteFlagImportConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getFlagImportConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getFlagImportConfigurations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchFlagImportConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

triggerFlagImportJob

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details