Skip to content

ReleasesBetaApi.md

Latest commit

 

History

History
312 lines (214 loc) · 9.36 KB

ReleasesBetaApi.md

File metadata and controls

312 lines (214 loc) · 9.36 KB

ReleasesBetaApi

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

Method HTTP request Description
createReleaseForFlag PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release Create a new release for flag
deleteReleaseByFlagKey DELETE /api/v2/flags/{projectKey}/{flagKey}/release Delete a release for flag
getReleaseByFlagKey GET /api/v2/flags/{projectKey}/{flagKey}/release Get release for flag
patchReleaseByFlagKey PATCH /api/v2/flags/{projectKey}/{flagKey}/release Patch release for flag
updatePhaseStatus PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} Update phase status for release

createReleaseForFlag

Release createReleaseForFlag(createReleaseInput)

Creates a release by adding a flag to a release pipeline

Example

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

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

let projectKey: string; //The project key (default to undefined)
let flagKey: string; //The flag key (default to undefined)
let createReleaseInput: CreateReleaseInput; //

const { status, data } = await apiInstance.createReleaseForFlag(
    projectKey,
    flagKey,
    createReleaseInput
);

Parameters

Name Type Description Notes
createReleaseInput CreateReleaseInput
projectKey [string] The project key defaults to undefined
flagKey [string] The flag key defaults to undefined

Return type

Release

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Release response -
400 Invalid request -
401 Invalid access token -
404 Invalid resource identifier -
429 Rate limit exceeded -

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

deleteReleaseByFlagKey

deleteReleaseByFlagKey()

Deletes a release from a flag

Example

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

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

let projectKey: string; //The project key (default to undefined)
let flagKey: string; //The flag key (default to undefined)

const { status, data } = await apiInstance.deleteReleaseByFlagKey(
    projectKey,
    flagKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
flagKey [string] The flag 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]

getReleaseByFlagKey

Release getReleaseByFlagKey()

Get currently active release for a flag

Example

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

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

let projectKey: string; //The project key (default to undefined)
let flagKey: string; //The flag key (default to undefined)

const { status, data } = await apiInstance.getReleaseByFlagKey(
    projectKey,
    flagKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
flagKey [string] The flag key defaults to undefined

Return type

Release

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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

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

patchReleaseByFlagKey

Release patchReleaseByFlagKey(patchOperation)

This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the Update phase status for release endpoint. Update currently active release for a flag. Updating releases requires the JSON patch format. To learn more, read Updates. You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the path. For example, to mark the first phase of a release as complete, use the following request body: [ { \"op\": \"replace\", \"path\": \"/phase/0/complete\", \"value\": true } ]

Example

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

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

let projectKey: string; //The project key (default to undefined)
let flagKey: string; //The flag key (default to undefined)
let patchOperation: Array<PatchOperation>; //

const { status, data } = await apiInstance.patchReleaseByFlagKey(
    projectKey,
    flagKey,
    patchOperation
);

Parameters

Name Type Description Notes
patchOperation Array
projectKey [string] The project key defaults to undefined
flagKey [string] The flag key defaults to undefined

Return type

Release

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Release response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

updatePhaseStatus

Release updatePhaseStatus(updatePhaseStatusInput)

Updates the execution status of a phase of a release

Example

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

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

let projectKey: string; //The project key (default to undefined)
let flagKey: string; //The flag key (default to undefined)
let phaseId: string; //The phase ID (default to undefined)
let updatePhaseStatusInput: UpdatePhaseStatusInput; //

const { status, data } = await apiInstance.updatePhaseStatus(
    projectKey,
    flagKey,
    phaseId,
    updatePhaseStatusInput
);

Parameters

Name Type Description Notes
updatePhaseStatusInput UpdatePhaseStatusInput
projectKey [string] The project key defaults to undefined
flagKey [string] The flag key defaults to undefined
phaseId [string] The phase ID defaults to undefined

Return type

Release

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Action succeeded -
400 Invalid request -
401 Invalid access token -
404 release or phase not found -
429 Rate limit exceeded -

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