LaunchDarklyApi\RelayProxyConfigurationsApi

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

Method	HTTP request	Description
deleteRelayAutoConfig()	DELETE /api/v2/account/relay-auto-configs/{id}	Delete Relay Proxy config by ID
getRelayProxyConfig()	GET /api/v2/account/relay-auto-configs/{id}	Get Relay Proxy config
getRelayProxyConfigs()	GET /api/v2/account/relay-auto-configs	List Relay Proxy configs
patchRelayAutoConfig()	PATCH /api/v2/account/relay-auto-configs/{id}	Update a Relay Proxy config
postRelayAutoConfig()	POST /api/v2/account/relay-auto-configs	Create a new Relay Proxy config
resetRelayAutoConfig()	POST /api/v2/account/relay-auto-configs/{id}/reset	Reset Relay Proxy configuration key

`deleteRelayAutoConfig()`

deleteRelayAutoConfig($id)

Delete Relay Proxy config by ID

Delete a Relay Proxy config.

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\RelayProxyConfigurationsApi(
    // 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
);
$id = 'id_example'; // string | The relay auto config id

try {
    $apiInstance->deleteRelayAutoConfig($id);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->deleteRelayAutoConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The relay auto config id

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]

`getRelayProxyConfig()`

getRelayProxyConfig($id): \LaunchDarklyApi\Model\RelayAutoConfigRep

Get Relay Proxy config

Get a single Relay Proxy auto config by ID.

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\RelayProxyConfigurationsApi(
    // 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
);
$id = 'id_example'; // string | The relay auto config id

try {
    $result = $apiInstance->getRelayProxyConfig($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->getRelayProxyConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The relay auto config id

Return type

\LaunchDarklyApi\Model\RelayAutoConfigRep

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]

`getRelayProxyConfigs()`

getRelayProxyConfigs(): \LaunchDarklyApi\Model\RelayAutoConfigCollectionRep

List Relay Proxy configs

Get a list of Relay Proxy configurations in the account.

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\RelayProxyConfigurationsApi(
    // 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->getRelayProxyConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->getRelayProxyConfigs: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\LaunchDarklyApi\Model\RelayAutoConfigCollectionRep

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]

`patchRelayAutoConfig()`

patchRelayAutoConfig($id, $patch_with_comment): \LaunchDarklyApi\Model\RelayAutoConfigRep

Update a Relay Proxy config

Update a Relay Proxy configuration. Updating a configuration uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.

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\RelayProxyConfigurationsApi(
    // 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
);
$id = 'id_example'; // string | The relay auto config id
$patch_with_comment = {"patch":[{"op":"replace","path":"/policy/0","value":{"actions":["*"],"effect":"allow","resources":["proj/*:env/qa"]}}]}; // \LaunchDarklyApi\Model\PatchWithComment

try {
    $result = $apiInstance->patchRelayAutoConfig($id, $patch_with_comment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->patchRelayAutoConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The relay auto config id
patch_with_comment	\LaunchDarklyApi\Model\PatchWithComment

Return type

\LaunchDarklyApi\Model\RelayAutoConfigRep

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]

`postRelayAutoConfig()`

postRelayAutoConfig($relay_auto_config_post): \LaunchDarklyApi\Model\RelayAutoConfigRep

Create a new Relay Proxy config

Create a Relay Proxy config.

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\RelayProxyConfigurationsApi(
    // 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
);
$relay_auto_config_post = {"name":"Sample Relay Proxy config for all proj and env","policy":[{"actions":["*"],"effect":"allow","resources":["proj/*:env/*"]}]}; // \LaunchDarklyApi\Model\RelayAutoConfigPost

try {
    $result = $apiInstance->postRelayAutoConfig($relay_auto_config_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->postRelayAutoConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
relay_auto_config_post	\LaunchDarklyApi\Model\RelayAutoConfigPost

Return type

\LaunchDarklyApi\Model\RelayAutoConfigRep

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]

`resetRelayAutoConfig()`

resetRelayAutoConfig($id, $expiry): \LaunchDarklyApi\Model\RelayAutoConfigRep

Reset Relay Proxy configuration key

Reset a Relay Proxy configuration's secret key with an optional expiry time for the old 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\RelayProxyConfigurationsApi(
    // 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
);
$id = 'id_example'; // string | The Relay Proxy configuration ID
$expiry = 56; // int | An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately.

try {
    $result = $apiInstance->resetRelayAutoConfig($id, $expiry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelayProxyConfigurationsApi->resetRelayAutoConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Relay Proxy configuration ID
expiry	int	An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately.	[optional]

Return type

\LaunchDarklyApi\Model\RelayAutoConfigRep

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]

Files

RelayProxyConfigurationsApi.md

Latest commit

History

RelayProxyConfigurationsApi.md

File metadata and controls

LaunchDarklyApi\RelayProxyConfigurationsApi

deleteRelayAutoConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

getRelayProxyConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

getRelayProxyConfigs()

Example

Parameters

Return type

Authorization

HTTP request headers

patchRelayAutoConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

postRelayAutoConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

resetRelayAutoConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteRelayAutoConfig()`

`getRelayProxyConfig()`

`getRelayProxyConfigs()`

`patchRelayAutoConfig()`

`postRelayAutoConfig()`

`resetRelayAutoConfig()`