LaunchDarklyApi\ReleasePipelinesBetaApi

All URIs are relative to https://app.launchdarkly.com, except if the operation defines another base path.

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($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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$pipeline_key = 'pipeline_key_example'; // string | The release pipeline key

try {
    $apiInstance->deleteReleasePipeline($project_key, $pipeline_key);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->deleteReleasePipeline: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

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

getAllReleasePipelines($project_key, $filter, $limit, $offset): \LaunchDarklyApi\Model\ReleasePipelineCollection

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_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.
$limit = 56; // int | The maximum number of items to return. Defaults to 20.
$offset = 56; // int | 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 {
    $result = $apiInstance->getAllReleasePipelines($project_key, $filter, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->getAllReleasePipelines: ', $e->getMessage(), PHP_EOL;
}

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	int	The maximum number of items to return. Defaults to 20.	[optional]
offset	int	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

\LaunchDarklyApi\Model\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()`

getAllReleaseProgressionsForReleasePipeline($project_key, $pipeline_key, $filter, $limit, $offset): \LaunchDarklyApi\Model\ReleaseProgressionCollection

Get release progressions for release pipeline

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$pipeline_key = 'pipeline_key_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.
$limit = 56; // int | The maximum number of items to return. Defaults to 20.
$offset = 56; // int | 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 {
    $result = $apiInstance->getAllReleaseProgressionsForReleasePipeline($project_key, $pipeline_key, $filter, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->getAllReleaseProgressionsForReleasePipeline: ', $e->getMessage(), PHP_EOL;
}

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	int	The maximum number of items to return. Defaults to 20.	[optional]
offset	int	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

\LaunchDarklyApi\Model\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()`

getReleasePipelineByKey($project_key, $pipeline_key): \LaunchDarklyApi\Model\ReleasePipeline

Get release pipeline by key

Get a release pipeline by key

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$pipeline_key = 'pipeline_key_example'; // string | The release pipeline key

try {
    $result = $apiInstance->getReleasePipelineByKey($project_key, $pipeline_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->getReleasePipelineByKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\LaunchDarklyApi\Model\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()`

postReleasePipeline($project_key, $create_release_pipeline_input): \LaunchDarklyApi\Model\ReleasePipeline

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$create_release_pipeline_input = new \LaunchDarklyApi\Model\CreateReleasePipelineInput(); // \LaunchDarklyApi\Model\CreateReleasePipelineInput

try {
    $result = $apiInstance->postReleasePipeline($project_key, $create_release_pipeline_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->postReleasePipeline: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
project_key	string	The project key
create_release_pipeline_input	\LaunchDarklyApi\Model\CreateReleasePipelineInput

Return type

\LaunchDarklyApi\Model\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()`

putReleasePipeline($project_key, $pipeline_key, $update_release_pipeline_input): \LaunchDarklyApi\Model\ReleasePipeline

Update a release pipeline

Updates a release pipeline.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ReleasePipelinesBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$pipeline_key = 'pipeline_key_example'; // string | The release pipeline key
$update_release_pipeline_input = new \LaunchDarklyApi\Model\UpdateReleasePipelineInput(); // \LaunchDarklyApi\Model\UpdateReleasePipelineInput

try {
    $result = $apiInstance->putReleasePipeline($project_key, $pipeline_key, $update_release_pipeline_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReleasePipelinesBetaApi->putReleasePipeline: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
project_key	string	The project key
pipeline_key	string	The release pipeline key
update_release_pipeline_input	\LaunchDarklyApi\Model\UpdateReleasePipelineInput

Return type

\LaunchDarklyApi\Model\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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LaunchDarklyApi\ReleasePipelinesBetaApi

`deleteReleasePipeline()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getAllReleasePipelines()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getAllReleaseProgressionsForReleasePipeline()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getReleasePipelineByKey()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postReleasePipeline()`

Example

Parameters

Return type

Authorization

HTTP request headers

`putReleasePipeline()`

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

ReleasePipelinesBetaApi.md

Latest commit

History

ReleasePipelinesBetaApi.md

File metadata and controls

LaunchDarklyApi\ReleasePipelinesBetaApi

deleteReleasePipeline()

Example

Parameters

Return type

Authorization

HTTP request headers

getAllReleasePipelines()

Example

Parameters

Return type

Authorization

HTTP request headers

getAllReleaseProgressionsForReleasePipeline()

Example

Parameters

Return type

Authorization

HTTP request headers

getReleasePipelineByKey()

Example

Parameters

Return type

Authorization

HTTP request headers

postReleasePipeline()

Example

Parameters

Return type

Authorization

HTTP request headers

putReleasePipeline()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteReleasePipeline()`

`getAllReleasePipelines()`

`getAllReleaseProgressionsForReleasePipeline()`

`getReleasePipelineByKey()`

`postReleasePipeline()`

`putReleasePipeline()`