All URIs are relative to https://app.launchdarkly.com.
Method | HTTP request | Description |
---|---|---|
deleteBranches() | POST /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches |
deleteRepository() | DELETE /api/v2/code-refs/repositories/{repo} | Delete repository |
getBranch() | GET /api/v2/code-refs/repositories/{repo}/branches/{branch} | Get branch |
getBranches() | GET /api/v2/code-refs/repositories/{repo}/branches | List branches |
getExtinctions() | GET /api/v2/code-refs/extinctions | List extinctions |
getRepositories() | GET /api/v2/code-refs/repositories | List repositories |
getRepository() | GET /api/v2/code-refs/repositories/{repo} | Get repository |
getRootStatistic() | GET /api/v2/code-refs/statistics | Get links to code reference repositories for each project |
getStatistics() | GET /api/v2/code-refs/statistics/{projectKey} | Get code references statistics for flags |
patchRepository() | PATCH /api/v2/code-refs/repositories/{repo} | Update repository |
postExtinction() | POST /api/v2/code-refs/repositories/{repo}/branches/{branch}/extinction-events | Create extinction |
postRepository() | POST /api/v2/code-refs/repositories | Create repository |
putBranch() | PUT /api/v2/code-refs/repositories/{repo}/branches/{branch} | Upsert branch |
deleteBranches($repo, $request_body)
Delete branches
Asynchronously delete a number of branches.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name to delete branches for.
$request_body = ["branch-to-be-deleted","another-branch-to-be-deleted"]; // string[]
try {
$apiInstance->deleteBranches($repo, $request_body);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->deleteBranches: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name to delete branches for. | |
request_body | string[] |
void (empty response body)
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteRepository($repo)
Delete repository
Delete a repository with the specified name.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
try {
$apiInstance->deleteRepository($repo);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->deleteRepository: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBranch($repo, $branch, $proj_key, $flag_key): \LaunchDarklyApi\Model\BranchRep
Get branch
Get a specific branch in a repository.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
$branch = 'branch_example'; // string | The url-encoded branch name
$proj_key = 'proj_key_example'; // string | Filter results to a specific project
$flag_key = 'flag_key_example'; // string | Filter results to a specific flag key
try {
$result = $apiInstance->getBranch($repo, $branch, $proj_key, $flag_key);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getBranch: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name | |
branch | string | The url-encoded branch name | |
proj_key | string | Filter results to a specific project | [optional] |
flag_key | string | Filter results to a specific flag key | [optional] |
\LaunchDarklyApi\Model\BranchRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBranches($repo): \LaunchDarklyApi\Model\BranchCollectionRep
List branches
Get a list of branches.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
try {
$result = $apiInstance->getBranches($repo);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getBranches: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name |
\LaunchDarklyApi\Model\BranchCollectionRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getExtinctions($repo_name, $branch_name, $proj_key, $flag_key, $from, $to): \LaunchDarklyApi\Model\ExtinctionCollectionRep
List extinctions
Get a list of all extinctions. LaunchDarkly creates an extinction event after you remove all code references to a flag. To learn more, read Understanding extinction events.
<?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\CodeReferencesApi(
// 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
);
$repo_name = 'repo_name_example'; // string | Filter results to a specific repository
$branch_name = 'branch_name_example'; // string | Filter results to a specific branch. By default, only the default branch will be queried for extinctions.
$proj_key = 'proj_key_example'; // string | Filter results to a specific project
$flag_key = 'flag_key_example'; // string | Filter results to a specific flag key
$from = 56; // int | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`.
$to = 56; // int | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`.
try {
$result = $apiInstance->getExtinctions($repo_name, $branch_name, $proj_key, $flag_key, $from, $to);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getExtinctions: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo_name | string | Filter results to a specific repository | [optional] |
branch_name | string | Filter results to a specific branch. By default, only the default branch will be queried for extinctions. | [optional] |
proj_key | string | Filter results to a specific project | [optional] |
flag_key | string | Filter results to a specific flag key | [optional] |
from | int | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`. | [optional] |
to | int | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`. | [optional] |
\LaunchDarklyApi\Model\ExtinctionCollectionRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getRepositories($with_branches, $with_references_for_default_branch, $proj_key, $flag_key): \LaunchDarklyApi\Model\RepositoryCollectionRep
List repositories
Get a list of connected repositories. Optionally, you can include branch metadata with the withBranches
query parameter. Embed references for the default branch with ReferencesForDefaultBranch
. You can also filter the list of code references by project key and flag key.
<?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\CodeReferencesApi(
// 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
);
$with_branches = 'with_branches_example'; // string | If set to any value, the endpoint returns repositories with associated branch data
$with_references_for_default_branch = 'with_references_for_default_branch_example'; // string | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
$proj_key = 'proj_key_example'; // string | A LaunchDarkly project key. If provided, this filters code reference results to the specified project.
$flag_key = 'flag_key_example'; // string | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
try {
$result = $apiInstance->getRepositories($with_branches, $with_references_for_default_branch, $proj_key, $flag_key);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getRepositories: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
with_branches | string | If set to any value, the endpoint returns repositories with associated branch data | [optional] |
with_references_for_default_branch | string | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch | [optional] |
proj_key | string | A LaunchDarkly project key. If provided, this filters code reference results to the specified project. | [optional] |
flag_key | string | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch | [optional] |
\LaunchDarklyApi\Model\RepositoryCollectionRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getRepository($repo): \LaunchDarklyApi\Model\RepositoryRep
Get repository
Get a single repository by name.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
try {
$result = $apiInstance->getRepository($repo);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getRepository: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name |
\LaunchDarklyApi\Model\RepositoryRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getRootStatistic(): \LaunchDarklyApi\Model\StatisticsRoot
Get links to code reference repositories for each project
Get links for all projects that have code references.
<?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\CodeReferencesApi(
// 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
);
try {
$result = $apiInstance->getRootStatistic();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getRootStatistic: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\LaunchDarklyApi\Model\StatisticsRoot
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getStatistics($project_key, $flag_key): \LaunchDarklyApi\Model\StatisticCollectionRep
Get code references statistics for flags
Get statistics about all the code references across repositories for all flags in your project that have code references in the default branch, for example, main
. Optionally, you can include the flagKey
query parameter to limit your request to statistics about code references for a single flag. This endpoint returns the number of references to your flag keys in your repositories, as well as a link to each repository.
<?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\CodeReferencesApi(
// 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
$flag_key = 'flag_key_example'; // string | Filter results to a specific flag key
try {
$result = $apiInstance->getStatistics($project_key, $flag_key);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->getStatistics: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
project_key | string | The project key | |
flag_key | string | Filter results to a specific flag key | [optional] |
\LaunchDarklyApi\Model\StatisticCollectionRep
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchRepository($repo, $patch_operation): \LaunchDarklyApi\Model\RepositoryRep
Update repository
Update a repository's settings. Updating repository settings uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
$patch_operation = [{"op":"replace","path":"/defaultBranch","value":"main"}]; // \LaunchDarklyApi\Model\PatchOperation[]
try {
$result = $apiInstance->patchRepository($repo, $patch_operation);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->patchRepository: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name | |
patch_operation | \LaunchDarklyApi\Model\PatchOperation[] |
\LaunchDarklyApi\Model\RepositoryRep
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
postExtinction($repo, $branch, $extinction)
Create extinction
Create a new extinction.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
$branch = 'branch_example'; // string | The URL-encoded branch name
$extinction = array(new \LaunchDarklyApi\Model\Extinction()); // \LaunchDarklyApi\Model\Extinction[]
try {
$apiInstance->postExtinction($repo, $branch, $extinction);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->postExtinction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name | |
branch | string | The URL-encoded branch name | |
extinction | \LaunchDarklyApi\Model\Extinction[] |
void (empty response body)
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
postRepository($repository_post): \LaunchDarklyApi\Model\RepositoryRep
Create repository
Create a repository with the specified name.
<?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\CodeReferencesApi(
// 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
);
$repository_post = new \LaunchDarklyApi\Model\RepositoryPost(); // \LaunchDarklyApi\Model\RepositoryPost
try {
$result = $apiInstance->postRepository($repository_post);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->postRepository: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repository_post | \LaunchDarklyApi\Model\RepositoryPost |
\LaunchDarklyApi\Model\RepositoryRep
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
putBranch($repo, $branch, $put_branch)
Upsert branch
Create a new branch if it doesn't exist, or update the branch if it already exists.
<?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\CodeReferencesApi(
// 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
);
$repo = 'repo_example'; // string | The repository name
$branch = 'branch_example'; // string | The URL-encoded branch name
$put_branch = new \LaunchDarklyApi\Model\PutBranch(); // \LaunchDarklyApi\Model\PutBranch
try {
$apiInstance->putBranch($repo, $branch, $put_branch);
} catch (Exception $e) {
echo 'Exception when calling CodeReferencesApi->putBranch: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
repo | string | The repository name | |
branch | string | The URL-encoded branch name | |
put_branch | \LaunchDarklyApi\Model\PutBranch |
void (empty response body)
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]