LaunchDarklyApi::ReleasePipelinesBetaApi

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

Method	HTTP request	Description
delete_release_pipeline	DELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Delete release pipeline
get_all_release_pipelines	GET /api/v2/projects/{projectKey}/release-pipelines	Get all release pipelines
get_all_release_progressions_for_release_pipeline	GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases	Get release progressions for release pipeline
get_release_pipeline_by_key	GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Get release pipeline by key
post_release_pipeline	POST /api/v2/projects/{projectKey}/release-pipelines	Create a release pipeline
put_release_pipeline	PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}	Update a release pipeline

delete_release_pipeline

delete_release_pipeline(project_key, pipeline_key)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
pipeline_key = 'pipeline_key_example' # String | The release pipeline key

begin
  # Delete release pipeline
  api_instance.delete_release_pipeline(project_key, pipeline_key)
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->delete_release_pipeline: #{e}"
end

Using the delete_release_pipeline_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_release_pipeline_with_http_info(project_key, pipeline_key)

begin
  # Delete release pipeline
  data, status_code, headers = api_instance.delete_release_pipeline_with_http_info(project_key, pipeline_key)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->delete_release_pipeline_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
project_key	String	The project key
pipeline_key	String	The release pipeline key

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_all_release_pipelines

get_all_release_pipelines(project_key, 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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
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, # Integer | The maximum number of items to return. Defaults to 20.
  offset: 789 # Integer | 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`.
}

begin
  # Get all release pipelines
  result = api_instance.get_all_release_pipelines(project_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_all_release_pipelines: #{e}"
end

Using the get_all_release_pipelines_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_all_release_pipelines_with_http_info(project_key, opts)

begin
  # Get all release pipelines
  data, status_code, headers = api_instance.get_all_release_pipelines_with_http_info(project_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReleasePipelineCollection>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_all_release_pipelines_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
project_key	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	Integer	The maximum number of items to return. Defaults to 20.	[optional]
offset	Integer	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

get_all_release_progressions_for_release_pipeline

get_all_release_progressions_for_release_pipeline(project_key, pipeline_key, opts)

Get release progressions for release pipeline

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

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
pipeline_key = 'pipeline_key_example' # String | The pipeline key
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, # Integer | The maximum number of items to return. Defaults to 20.
  offset: 789 # Integer | 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`.
}

begin
  # Get release progressions for release pipeline
  result = api_instance.get_all_release_progressions_for_release_pipeline(project_key, pipeline_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_all_release_progressions_for_release_pipeline: #{e}"
end

Using the get_all_release_progressions_for_release_pipeline_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_all_release_progressions_for_release_pipeline_with_http_info(project_key, pipeline_key, opts)

begin
  # Get release progressions for release pipeline
  data, status_code, headers = api_instance.get_all_release_progressions_for_release_pipeline_with_http_info(project_key, pipeline_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReleaseProgressionCollection>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_all_release_progressions_for_release_pipeline_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
project_key	String	The project key
pipeline_key	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	Integer	The maximum number of items to return. Defaults to 20.	[optional]
offset	Integer	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

get_release_pipeline_by_key

get_release_pipeline_by_key(project_key, pipeline_key)

Get release pipeline by key

Get a release pipeline by key

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
pipeline_key = 'pipeline_key_example' # String | The release pipeline key

begin
  # Get release pipeline by key
  result = api_instance.get_release_pipeline_by_key(project_key, pipeline_key)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_release_pipeline_by_key: #{e}"
end

Using the get_release_pipeline_by_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_release_pipeline_by_key_with_http_info(project_key, pipeline_key)

begin
  # Get release pipeline by key
  data, status_code, headers = api_instance.get_release_pipeline_by_key_with_http_info(project_key, pipeline_key)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReleasePipeline>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->get_release_pipeline_by_key_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
project_key	String	The project key
pipeline_key	String	The release pipeline key

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

post_release_pipeline

post_release_pipeline(project_key, create_release_pipeline_input)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
create_release_pipeline_input = LaunchDarklyApi::CreateReleasePipelineInput.new({key: 'standard-pipeline', name: 'Standard Pipeline', phases: [LaunchDarklyApi::CreatePhaseInput.new({audiences: [LaunchDarklyApi::AudiencePost.new({environment_key: 'environment_key_example', name: 'name_example'})], name: 'Phase 1 - Testing'})]}) # CreateReleasePipelineInput | 

begin
  # Create a release pipeline
  result = api_instance.post_release_pipeline(project_key, create_release_pipeline_input)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->post_release_pipeline: #{e}"
end

Using the post_release_pipeline_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_release_pipeline_with_http_info(project_key, create_release_pipeline_input)

begin
  # Create a release pipeline
  data, status_code, headers = api_instance.post_release_pipeline_with_http_info(project_key, create_release_pipeline_input)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReleasePipeline>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->post_release_pipeline_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
project_key	String	The project key
create_release_pipeline_input	CreateReleasePipelineInput

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

put_release_pipeline

put_release_pipeline(project_key, pipeline_key, update_release_pipeline_input)

Update a release pipeline

Updates a release pipeline.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ReleasePipelinesBetaApi.new
project_key = 'project_key_example' # String | The project key
pipeline_key = 'pipeline_key_example' # String | The release pipeline key
update_release_pipeline_input = LaunchDarklyApi::UpdateReleasePipelineInput.new({name: 'Standard Pipeline', phases: [LaunchDarklyApi::CreatePhaseInput.new({audiences: [LaunchDarklyApi::AudiencePost.new({environment_key: 'environment_key_example', name: 'name_example'})], name: 'Phase 1 - Testing'})]}) # UpdateReleasePipelineInput | 

begin
  # Update a release pipeline
  result = api_instance.put_release_pipeline(project_key, pipeline_key, update_release_pipeline_input)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->put_release_pipeline: #{e}"
end

Using the put_release_pipeline_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_release_pipeline_with_http_info(project_key, pipeline_key, update_release_pipeline_input)

begin
  # Update a release pipeline
  data, status_code, headers = api_instance.put_release_pipeline_with_http_info(project_key, pipeline_key, update_release_pipeline_input)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReleasePipeline>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ReleasePipelinesBetaApi->put_release_pipeline_with_http_info: #{e}"
end

Parameters

Name	Type	Description
project_key	String	The project key
pipeline_key	String	The release pipeline key
update_release_pipeline_input	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

delete_release_pipeline

Examples

Using the delete_release_pipeline_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_all_release_pipelines

Examples

Using the get_all_release_pipelines_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_all_release_progressions_for_release_pipeline

Examples

Using the get_all_release_progressions_for_release_pipeline_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_release_pipeline_by_key

Examples

Using the get_release_pipeline_by_key_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

post_release_pipeline

Examples

Using the post_release_pipeline_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

put_release_pipeline

Examples

Using the put_release_pipeline_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers