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 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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String pipelineKey = "pipelineKey_example"; // String | The release pipeline key
    try {
      apiInstance.deleteReleasePipeline(projectKey, pipelineKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#deleteReleasePipeline");
      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	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

HTTP response details

Status code	Description	Response headers
204	Action succeeded	-
403	Forbidden	-
404	Invalid resource identifier	-

getAllReleasePipelines

ReleasePipelineCollection getAllReleasePipelines(projectKey, filter, limit, offset)

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 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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String 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.
    Long limit = 56L; // Long | The maximum number of items to return. Defaults to 20.
    Long offset = 56L; // Long | 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`.
    try {
      ReleasePipelineCollection result = apiInstance.getAllReleasePipelines(projectKey, filter, limit, offset);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#getAllReleasePipelines");
      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	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	Long	The maximum number of items to return. Defaults to 20.	[optional]
offset	Long	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

HTTP response details

Status code	Description	Response headers
200	Release pipeline collection	-
404	Invalid resource identifier	-

getAllReleaseProgressionsForReleasePipeline

ReleaseProgressionCollection getAllReleaseProgressionsForReleasePipeline(projectKey, pipelineKey, filter, limit, offset)

Get release progressions for release pipeline

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

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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String pipelineKey = "pipelineKey_example"; // String | The pipeline key
    String 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.
    Long limit = 56L; // Long | The maximum number of items to return. Defaults to 20.
    Long offset = 56L; // Long | 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`.
    try {
      ReleaseProgressionCollection result = apiInstance.getAllReleaseProgressionsForReleasePipeline(projectKey, pipelineKey, filter, limit, offset);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#getAllReleaseProgressionsForReleasePipeline");
      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	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	Long	The maximum number of items to return. Defaults to 20.	[optional]
offset	Long	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

HTTP response details

Status code	Description	Response headers
200	Release progression collection	-
404	Invalid resource identifier	-

getReleasePipelineByKey

ReleasePipeline getReleasePipelineByKey(projectKey, pipelineKey)

Get release pipeline by key

Get a release pipeline by key

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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String pipelineKey = "pipelineKey_example"; // String | The release pipeline key
    try {
      ReleasePipeline result = apiInstance.getReleasePipelineByKey(projectKey, pipelineKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#getReleasePipelineByKey");
      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	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

HTTP response details

Status code	Description	Response headers
200	Release pipeline response	-
404	Invalid resource identifier	-

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 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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    CreateReleasePipelineInput createReleasePipelineInput = new CreateReleasePipelineInput(); // CreateReleasePipelineInput | 
    try {
      ReleasePipeline result = apiInstance.postReleasePipeline(projectKey, createReleasePipelineInput);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#postReleasePipeline");
      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	Notes
projectKey	String	The project key
createReleasePipelineInput	CreateReleasePipelineInput

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Release pipeline response	-
400	Invalid request	-
403	Forbidden	-
404	Invalid resource identifier	-
409	Status conflict	-

putReleasePipeline

ReleasePipeline putReleasePipeline(projectKey, pipelineKey, updateReleasePipelineInput)

Update a release pipeline

Updates a release pipeline.

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.ReleasePipelinesBetaApi;

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");

    ReleasePipelinesBetaApi apiInstance = new ReleasePipelinesBetaApi(defaultClient);
    String projectKey = "projectKey_example"; // String | The project key
    String pipelineKey = "pipelineKey_example"; // String | The release pipeline key
    UpdateReleasePipelineInput updateReleasePipelineInput = new UpdateReleasePipelineInput(); // UpdateReleasePipelineInput | 
    try {
      ReleasePipeline result = apiInstance.putReleasePipeline(projectKey, pipelineKey, updateReleasePipelineInput);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleasePipelinesBetaApi#putReleasePipeline");
      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
pipelineKey	String	The release pipeline key
updateReleasePipelineInput	UpdateReleasePipelineInput

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Release pipeline response	-
400	Invalid request	-
403	Forbidden	-
404	Invalid resource identifier	-

Files

ReleasePipelinesBetaApi.md

Latest commit

History

ReleasePipelinesBetaApi.md

File metadata and controls

ReleasePipelinesBetaApi

deleteReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAllReleasePipelines

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAllReleaseProgressionsForReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getReleasePipelineByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

putReleasePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details