Skip to content

ReleasePipelinesBetaApi.md

Latest commit

 

History

History
369 lines (252 loc) · 14.1 KB

ReleasePipelinesBetaApi.md

File metadata and controls

369 lines (252 loc) · 14.1 KB

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()

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 {
    ReleasePipelinesBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let pipelineKey: string; //The release pipeline key (default to undefined)

const { status, data } = await apiInstance.deleteReleasePipeline(
    projectKey,
    pipelineKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
pipelineKey [string] The release pipeline key defaults to undefined

Return type

void (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 -

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

getAllReleasePipelines

ReleasePipelineCollection getAllReleasePipelines()

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 {
    ReleasePipelinesBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let 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) (default to undefined)
let limit: number; //The maximum number of items to return. Defaults to 20. (optional) (default to undefined)
let 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) (default to undefined)

const { status, data } = await apiInstance.getAllReleasePipelines(
    projectKey,
    filter,
    limit,
    offset
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
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) defaults to undefined
limit [number] The maximum number of items to return. Defaults to 20. (optional) defaults to undefined
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) defaults to undefined

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 -

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

getAllReleaseProgressionsForReleasePipeline

ReleaseProgressionCollection getAllReleaseProgressionsForReleasePipeline()

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

Example

import {
    ReleasePipelinesBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let pipelineKey: string; //The pipeline key (default to undefined)
let 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) (default to undefined)
let limit: number; //The maximum number of items to return. Defaults to 20. (optional) (default to undefined)
let 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) (default to undefined)

const { status, data } = await apiInstance.getAllReleaseProgressionsForReleasePipeline(
    projectKey,
    pipelineKey,
    filter,
    limit,
    offset
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
pipelineKey [string] The pipeline key defaults to undefined
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) defaults to undefined
limit [number] The maximum number of items to return. Defaults to 20. (optional) defaults to undefined
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) defaults to undefined

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 -

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

getReleasePipelineByKey

ReleasePipeline getReleasePipelineByKey()

Get a release pipeline by key

Example

import {
    ReleasePipelinesBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let pipelineKey: string; //The release pipeline key (default to undefined)

const { status, data } = await apiInstance.getReleasePipelineByKey(
    projectKey,
    pipelineKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
pipelineKey [string] The release pipeline key defaults to undefined

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 -

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

postReleasePipeline

ReleasePipeline postReleasePipeline(createReleasePipelineInput)

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 {
    ReleasePipelinesBetaApi,
    Configuration,
    CreateReleasePipelineInput
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let createReleasePipelineInput: CreateReleasePipelineInput; //

const { status, data } = await apiInstance.postReleasePipeline(
    projectKey,
    createReleasePipelineInput
);

Parameters

Name Type Description Notes
createReleasePipelineInput CreateReleasePipelineInput
projectKey [string] The project key defaults to undefined

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 -

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

putReleasePipeline

ReleasePipeline putReleasePipeline(updateReleasePipelineInput)

Updates a release pipeline.

Example

import {
    ReleasePipelinesBetaApi,
    Configuration,
    UpdateReleasePipelineInput
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new ReleasePipelinesBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let pipelineKey: string; //The release pipeline key (default to undefined)
let updateReleasePipelineInput: UpdateReleasePipelineInput; //

const { status, data } = await apiInstance.putReleasePipeline(
    projectKey,
    pipelineKey,
    updateReleasePipelineInput
);

Parameters

Name Type Description Notes
updateReleasePipelineInput UpdateReleasePipelineInput
projectKey [string] The project key defaults to undefined
pipelineKey [string] The release pipeline key defaults to undefined

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 -

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