LaunchDarklyApi.ReleasePipelinesBetaApi

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

Method	HTTP request	Description
deleteReleasePipeline	DELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Delete release pipeline
getAllReleasePipelines	GET /api/v2/projects/{projectKey}/release-pipelines	Get all release pipelines
getAllReleaseProgressionsForReleasePipeline	GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases	Get release progressions for release pipeline
getReleasePipelineByKey	GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Get release pipeline by key
postReleasePipeline	POST /api/v2/projects/{projectKey}/release-pipelines	Create a release pipeline
putReleasePipeline	PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Update a release pipeline

deleteReleasePipeline

deleteReleasePipeline(projectKey, pipelineKey)

Delete release pipeline

Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the Update project API to set the `defaultReleasePipelineKey`.

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let pipelineKey = "pipelineKey_example"; // String | The release pipeline key
apiInstance.deleteReleasePipeline(projectKey, pipelineKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
pipelineKey	String	The release pipeline key

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAllReleasePipelines

ReleasePipelineCollection getAllReleasePipelines(projectKey, opts)

Get all release pipelines

Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`. - `env` is a string that matches an environment key. For example: `?filter=env:production`.

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let opts = {
  'filter': "filter_example", // String | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.
  'limit': 789, // Number | The maximum number of items to return. Defaults to 20.
  'offset': 789 // Number | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
};
apiInstance.getAllReleasePipelines(projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
filter	String	A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.	[optional]
limit	Number	The maximum number of items to return. Defaults to 20.	[optional]
offset	Number	Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]

Return type

ReleasePipelineCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAllReleaseProgressionsForReleasePipeline

ReleaseProgressionCollection getAllReleaseProgressionsForReleasePipeline(projectKey, pipelineKey, opts)

Get release progressions for release pipeline

Get details on the progression of all releases, across all flags, for a release pipeline

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let pipelineKey = "pipelineKey_example"; // String | The pipeline key
let opts = {
  'filter': "filter_example", // String | Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone.
  'limit': 789, // Number | The maximum number of items to return. Defaults to 20.
  'offset': 789 // Number | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
};
apiInstance.getAllReleaseProgressionsForReleasePipeline(projectKey, pipelineKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
pipelineKey	String	The pipeline key
filter	String	Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone.	[optional]
limit	Number	The maximum number of items to return. Defaults to 20.	[optional]
offset	Number	Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]

Return type

ReleaseProgressionCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getReleasePipelineByKey

ReleasePipeline getReleasePipelineByKey(projectKey, pipelineKey)

Get release pipeline by key

Get a release pipeline by key

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let pipelineKey = "pipelineKey_example"; // String | The release pipeline key
apiInstance.getReleasePipelineByKey(projectKey, pipelineKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
pipelineKey	String	The release pipeline key

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

postReleasePipeline

ReleasePipeline postReleasePipeline(projectKey, createReleasePipelineInput)

Create a release pipeline

Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the Update project API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let createReleasePipelineInput = new LaunchDarklyApi.CreateReleasePipelineInput(); // CreateReleasePipelineInput | 
apiInstance.postReleasePipeline(projectKey, createReleasePipelineInput, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
createReleasePipelineInput	CreateReleasePipelineInput

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

putReleasePipeline

ReleasePipeline putReleasePipeline(projectKey, pipelineKey, updateReleasePipelineInput)

Update a release pipeline

Updates a release pipeline.

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.ReleasePipelinesBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let pipelineKey = "pipelineKey_example"; // String | The release pipeline key
let updateReleasePipelineInput = new LaunchDarklyApi.UpdateReleasePipelineInput(); // UpdateReleasePipelineInput | 
apiInstance.putReleasePipeline(projectKey, pipelineKey, updateReleasePipelineInput, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
projectKey	String	The project key
pipelineKey	String	The release pipeline key
updateReleasePipelineInput	UpdateReleasePipelineInput

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

Files

ReleasePipelinesBetaApi.md

Latest commit

History

ReleasePipelinesBetaApi.md

File metadata and controls

LaunchDarklyApi.ReleasePipelinesBetaApi

deleteReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

getAllReleasePipelines

Example

Parameters

Return type

Authorization

HTTP request headers

getAllReleaseProgressionsForReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

getReleasePipelineByKey

Example

Parameters

Return type

Authorization

HTTP request headers

postReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

putReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers