Skip to content

IntegrationsBetaApi.md

Latest commit

 

History

History
300 lines (202 loc) · 9.9 KB

IntegrationsBetaApi.md

File metadata and controls

300 lines (202 loc) · 9.9 KB

IntegrationsBetaApi

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

Method HTTP request Description
createIntegrationConfiguration POST /api/v2/integration-configurations/keys/{integrationKey} Create integration configuration
deleteIntegrationConfiguration DELETE /api/v2/integration-configurations/{integrationConfigurationId} Delete integration configuration
getAllIntegrationConfigurations GET /api/v2/integration-configurations/keys/{integrationKey} Get all configurations for the integration
getIntegrationConfiguration GET /api/v2/integration-configurations/{integrationConfigurationId} Get an integration configuration
updateIntegrationConfiguration PATCH /api/v2/integration-configurations/{integrationConfigurationId} Update integration configuration

createIntegrationConfiguration

IntegrationConfigurationsRep createIntegrationConfiguration(integrationConfigurationPost)

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

Example

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

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

let integrationKey: string; //The integration key (default to undefined)
let integrationConfigurationPost: IntegrationConfigurationPost; //

const { status, data } = await apiInstance.createIntegrationConfiguration(
    integrationKey,
    integrationConfigurationPost
);

Parameters

Name Type Description Notes
integrationConfigurationPost IntegrationConfigurationPost
integrationKey [string] The integration key defaults to undefined

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Integration Configuration response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration key not found -
409 Status conflict -
429 Rate limited -

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

deleteIntegrationConfiguration

deleteIntegrationConfiguration()

Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)

Example

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

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

let integrationConfigurationId: string; //The ID of the integration configuration to be deleted (default to undefined)

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

Parameters

Name Type Description Notes
integrationConfigurationId [string] The ID of the integration configuration to be deleted 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 succeeded -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getAllIntegrationConfigurations

IntegrationConfigurationCollectionRep getAllIntegrationConfigurations()

Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations.).

Example

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

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

let integrationKey: string; //Integration key (default to undefined)

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

Parameters

Name Type Description Notes
integrationKey [string] Integration key defaults to undefined

Return type

IntegrationConfigurationCollectionRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List of Integration Configurations -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration key not found -
429 Rate limited -

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

getIntegrationConfiguration

IntegrationConfigurationsRep getIntegrationConfiguration()

Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)

Example

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

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

let integrationConfigurationId: string; //Integration configuration ID (default to undefined)

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

Parameters

Name Type Description Notes
integrationConfigurationId [string] Integration configuration ID defaults to undefined

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Integration Configuration response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration ID not found -
429 Rate limited -

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

updateIntegrationConfiguration

IntegrationConfigurationsRep updateIntegrationConfiguration(patchOperation)

Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

Example

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

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

let integrationConfigurationId: string; //The ID of the integration configuration (default to undefined)
let patchOperation: Array<PatchOperation>; //

const { status, data } = await apiInstance.updateIntegrationConfiguration(
    integrationConfigurationId,
    patchOperation
);

Parameters

Name Type Description Notes
patchOperation Array
integrationConfigurationId [string] The ID of the integration configuration defaults to undefined

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Integration configuration response -
400 Invalid request -
403 Forbidden -
404 Invalid resource identifier -
409 Status conflict -
429 Rate limited -

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