Skip to content

FlagImportConfigurationsBetaApi.md

Latest commit

 

History

History
381 lines (266 loc) · 13 KB

FlagImportConfigurationsBetaApi.md

File metadata and controls

381 lines (266 loc) · 13 KB

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(flagImportConfigurationPost)

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.

Example

import {
    FlagImportConfigurationsBetaApi,
    Configuration,
    FlagImportConfigurationPost
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let integrationKey: string; //The integration key (default to undefined)
let flagImportConfigurationPost: FlagImportConfigurationPost; //

const { status, data } = await apiInstance.createFlagImportConfiguration(
    projectKey,
    integrationKey,
    flagImportConfigurationPost
);

Parameters

Name Type Description Notes
flagImportConfigurationPost FlagImportConfigurationPost
projectKey [string] The project key defaults to undefined
integrationKey [string] The integration key defaults to undefined

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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFlagImportConfiguration

deleteFlagImportConfiguration()

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 {
    FlagImportConfigurationsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let integrationKey: string; //The integration key (default to undefined)
let integrationId: string; //The integration ID (default to undefined)

const { status, data } = await apiInstance.deleteFlagImportConfiguration(
    projectKey,
    integrationKey,
    integrationId
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
integrationKey [string] The integration key defaults to undefined
integrationId [string] The integration ID defaults to undefined

Return type

void (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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFlagImportConfiguration

FlagImportIntegration getFlagImportConfiguration()

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 {
    FlagImportConfigurationsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let integrationKey: string; //The integration key, for example, `split` (default to undefined)
let integrationId: string; //The integration ID (default to undefined)

const { status, data } = await apiInstance.getFlagImportConfiguration(
    projectKey,
    integrationKey,
    integrationId
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
integrationKey [string] The integration key, for example, `split` defaults to undefined
integrationId [string] The integration ID defaults to undefined

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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFlagImportConfigurations

FlagImportIntegrationCollection getFlagImportConfigurations()

List all flag import configurations.

Example

import {
    FlagImportConfigurationsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

const { status, data } = await apiInstance.getFlagImportConfigurations();

Parameters

This endpoint does not have any parameters.

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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchFlagImportConfiguration

FlagImportIntegration patchFlagImportConfiguration(patchOperation)

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.

Example

import {
    FlagImportConfigurationsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let integrationKey: string; //The integration key (default to undefined)
let integrationId: string; //The integration ID (default to undefined)
let patchOperation: Array<PatchOperation>; //

const { status, data } = await apiInstance.patchFlagImportConfiguration(
    projectKey,
    integrationKey,
    integrationId,
    patchOperation
);

Parameters

Name Type Description Notes
patchOperation Array
projectKey [string] The project key defaults to undefined
integrationKey [string] The integration key defaults to undefined
integrationId [string] The integration ID defaults to undefined

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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

triggerFlagImportJob

triggerFlagImportJob()

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 {
    FlagImportConfigurationsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new FlagImportConfigurationsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let integrationKey: string; //The integration key (default to undefined)
let integrationId: string; //The integration ID (default to undefined)

const { status, data } = await apiInstance.triggerFlagImportJob(
    projectKey,
    integrationKey,
    integrationId
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
integrationKey [string] The integration key defaults to undefined
integrationId [string] The integration ID defaults to undefined

Return type

void (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 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]