Skip to content

Latest commit

 

History

History
272 lines (183 loc) · 9.45 KB

IntegrationsBetaApi.md

File metadata and controls

272 lines (183 loc) · 9.45 KB

LaunchDarklyApi.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(integrationKey, integrationConfigurationPost)

Create integration configuration

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationsBetaApi();
let integrationKey = "integrationKey_example"; // String | The integration key
let integrationConfigurationPost = new LaunchDarklyApi.IntegrationConfigurationPost(); // IntegrationConfigurationPost | 
apiInstance.createIntegrationConfiguration(integrationKey, integrationConfigurationPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key
integrationConfigurationPost IntegrationConfigurationPost

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

deleteIntegrationConfiguration

deleteIntegrationConfiguration(integrationConfigurationId)

Delete integration configuration

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationsBetaApi();
let integrationConfigurationId = "integrationConfigurationId_example"; // String | The ID of the integration configuration to be deleted
apiInstance.deleteIntegrationConfiguration(integrationConfigurationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
integrationConfigurationId String The ID of the integration configuration to be deleted

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

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

getAllIntegrationConfigurations

IntegrationConfigurationCollectionRep getAllIntegrationConfigurations(integrationKey)

Get all configurations for the integration

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationsBetaApi();
let integrationKey = "integrationKey_example"; // String | Integration key
apiInstance.getAllIntegrationConfigurations(integrationKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String Integration key

Return type

IntegrationConfigurationCollectionRep

Authorization

ApiKey

HTTP request headers

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

getIntegrationConfiguration

IntegrationConfigurationsRep getIntegrationConfiguration(integrationConfigurationId)

Get an integration configuration

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationsBetaApi();
let integrationConfigurationId = "integrationConfigurationId_example"; // String | Integration configuration ID
apiInstance.getIntegrationConfiguration(integrationConfigurationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationConfigurationId String Integration configuration ID

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

updateIntegrationConfiguration

IntegrationConfigurationsRep updateIntegrationConfiguration(integrationConfigurationId, patchOperation)

Update integration configuration

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationsBetaApi();
let integrationConfigurationId = "integrationConfigurationId_example"; // String | The ID of the integration configuration
let patchOperation = [{"op":"replace","path":"/on","value":false}]; // [PatchOperation] | 
apiInstance.updateIntegrationConfiguration(integrationConfigurationId, patchOperation, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationConfigurationId String The ID of the integration configuration
patchOperation [PatchOperation]

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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