\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(ctx, projectKey, pipelineKey).Execute()

Delete release pipeline

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	pipelineKey := "pipelineKey_example" // string | The release pipeline key

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ReleasePipelinesBetaApi.DeleteReleasePipeline(context.Background(), projectKey, pipelineKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.DeleteReleasePipeline``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key
pipelineKey	string	The release pipeline key

Other Parameters

Other parameters are passed through a pointer to a apiDeleteReleasePipelineRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetAllReleasePipelines

ReleasePipelineCollection GetAllReleasePipelines(ctx, projectKey).Filter(filter).Limit(limit).Offset(offset).Execute()

Get all release pipelines

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	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. (optional)
	limit := int64(789) // int64 | The maximum number of items to return. Defaults to 20. (optional)
	offset := int64(789) // int64 | 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)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReleasePipelinesBetaApi.GetAllReleasePipelines(context.Background(), projectKey).Filter(filter).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.GetAllReleasePipelines``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllReleasePipelines`: ReleasePipelineCollection
	fmt.Fprintf(os.Stdout, "Response from `ReleasePipelinesBetaApi.GetAllReleasePipelines`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key

Other Parameters

Other parameters are passed through a pointer to a apiGetAllReleasePipelinesRequest struct via the builder pattern

Name	Type	Description	Notes

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. | limit | int64 | The maximum number of items to return. Defaults to 20. | offset | int64 | 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`. |

Return type

ReleasePipelineCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetAllReleaseProgressionsForReleasePipeline

ReleaseProgressionCollection GetAllReleaseProgressionsForReleasePipeline(ctx, projectKey, pipelineKey).Filter(filter).Limit(limit).Offset(offset).Execute()

Get release progressions for release pipeline

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	pipelineKey := "pipelineKey_example" // string | The pipeline key
	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. (optional)
	limit := int64(789) // int64 | The maximum number of items to return. Defaults to 20. (optional)
	offset := int64(789) // int64 | 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)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReleasePipelinesBetaApi.GetAllReleaseProgressionsForReleasePipeline(context.Background(), projectKey, pipelineKey).Filter(filter).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.GetAllReleaseProgressionsForReleasePipeline``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllReleaseProgressionsForReleasePipeline`: ReleaseProgressionCollection
	fmt.Fprintf(os.Stdout, "Response from `ReleasePipelinesBetaApi.GetAllReleaseProgressionsForReleasePipeline`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key
pipelineKey	string	The pipeline key

Other Parameters

Other parameters are passed through a pointer to a apiGetAllReleaseProgressionsForReleasePipelineRequest struct via the builder pattern

Name	Type	Description	Notes

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. | limit | int64 | The maximum number of items to return. Defaults to 20. | offset | int64 | 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`. |

Return type

ReleaseProgressionCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetReleasePipelineByKey

ReleasePipeline GetReleasePipelineByKey(ctx, projectKey, pipelineKey).Execute()

Get release pipeline by key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	pipelineKey := "pipelineKey_example" // string | The release pipeline key

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReleasePipelinesBetaApi.GetReleasePipelineByKey(context.Background(), projectKey, pipelineKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.GetReleasePipelineByKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetReleasePipelineByKey`: ReleasePipeline
	fmt.Fprintf(os.Stdout, "Response from `ReleasePipelinesBetaApi.GetReleasePipelineByKey`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key
pipelineKey	string	The release pipeline key

Other Parameters

Other parameters are passed through a pointer to a apiGetReleasePipelineByKeyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PostReleasePipeline

ReleasePipeline PostReleasePipeline(ctx, projectKey).CreateReleasePipelineInput(createReleasePipelineInput).Execute()

Create a release pipeline

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	createReleasePipelineInput := *openapiclient.NewCreateReleasePipelineInput("standard-pipeline", "Standard Pipeline", []openapiclient.CreatePhaseInput{*openapiclient.NewCreatePhaseInput([]openapiclient.AudiencePost{*openapiclient.NewAudiencePost("EnvironmentKey_example", "Name_example")}, "Phase 1 - Testing")}) // CreateReleasePipelineInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReleasePipelinesBetaApi.PostReleasePipeline(context.Background(), projectKey).CreateReleasePipelineInput(createReleasePipelineInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.PostReleasePipeline``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostReleasePipeline`: ReleasePipeline
	fmt.Fprintf(os.Stdout, "Response from `ReleasePipelinesBetaApi.PostReleasePipeline`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key

Other Parameters

Other parameters are passed through a pointer to a apiPostReleasePipelineRequest struct via the builder pattern

Name	Type	Description	Notes

createReleasePipelineInput | CreateReleasePipelineInput | |

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

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

PutReleasePipeline

ReleasePipeline PutReleasePipeline(ctx, projectKey, pipelineKey).UpdateReleasePipelineInput(updateReleasePipelineInput).Execute()

Update a release pipeline

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/launchdarkly/api-client-go"
)

func main() {
	projectKey := "projectKey_example" // string | The project key
	pipelineKey := "pipelineKey_example" // string | The release pipeline key
	updateReleasePipelineInput := *openapiclient.NewUpdateReleasePipelineInput("Standard Pipeline", []openapiclient.CreatePhaseInput{*openapiclient.NewCreatePhaseInput([]openapiclient.AudiencePost{*openapiclient.NewAudiencePost("EnvironmentKey_example", "Name_example")}, "Phase 1 - Testing")}) // UpdateReleasePipelineInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReleasePipelinesBetaApi.PutReleasePipeline(context.Background(), projectKey, pipelineKey).UpdateReleasePipelineInput(updateReleasePipelineInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleasePipelinesBetaApi.PutReleasePipeline``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutReleasePipeline`: ReleasePipeline
	fmt.Fprintf(os.Stdout, "Response from `ReleasePipelinesBetaApi.PutReleasePipeline`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectKey	string	The project key
pipelineKey	string	The release pipeline key

Other Parameters

Other parameters are passed through a pointer to a apiPutReleasePipelineRequest struct via the builder pattern

Name	Type	Description	Notes

updateReleasePipelineInput | UpdateReleasePipelineInput | |

Return type

ReleasePipeline

Authorization

ApiKey

HTTP request headers

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

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

FilesExpand file tree

ReleasePipelinesBetaApi.md

Latest commit

History

ReleasePipelinesBetaApi.md

File metadata and controls

\ReleasePipelinesBetaApi

DeleteReleasePipeline

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAllReleasePipelines

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAllReleaseProgressionsForReleasePipeline

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetReleasePipelineByKey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostReleasePipeline

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutReleasePipeline

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers