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

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    String id = "id_example"; // String | The relay auto config id
    try {
      apiInstance.deleteRelayAutoConfig(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#deleteRelayAutoConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	The relay auto config id

Return type

null (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	-
401	Invalid access token	-
404	Invalid resource identifier	-
409	Status conflict	-
429	Rate limited	-

getRelayProxyConfig

RelayAutoConfigRep getRelayProxyConfig(id)

Get Relay Proxy config

Get a single Relay Proxy auto config by ID.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    String id = "id_example"; // String | The relay auto config id
    try {
      RelayAutoConfigRep result = apiInstance.getRelayProxyConfig(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#getRelayProxyConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	The relay auto config id

Return type

RelayAutoConfigRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Relay auto config response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

getRelayProxyConfigs

RelayAutoConfigCollectionRep getRelayProxyConfigs()

List Relay Proxy configs

Get a list of Relay Proxy configurations in the account.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    try {
      RelayAutoConfigCollectionRep result = apiInstance.getRelayProxyConfigs();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#getRelayProxyConfigs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

RelayAutoConfigCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Relay auto configs collection response	-
401	Invalid access token	-
403	Forbidden	-
429	Rate limited	-

patchRelayAutoConfig

RelayAutoConfigRep patchRelayAutoConfig(id, patchWithComment)

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

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    String id = "id_example"; // String | The relay auto config id
    PatchWithComment patchWithComment = new PatchWithComment(); // PatchWithComment | 
    try {
      RelayAutoConfigRep result = apiInstance.patchRelayAutoConfig(id, patchWithComment);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#patchRelayAutoConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	The relay auto config id
patchWithComment	PatchWithComment

Return type

RelayAutoConfigRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Relay auto config response	-
400	Invalid request	-
401	Invalid access token	-
404	Invalid resource identifier	-
409	Status conflict	-
422	Invalid patch content	-
429	Rate limited	-

postRelayAutoConfig

RelayAutoConfigRep postRelayAutoConfig(relayAutoConfigPost)

Create a new Relay Proxy config

Create a Relay Proxy config.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    RelayAutoConfigPost relayAutoConfigPost = new RelayAutoConfigPost(); // RelayAutoConfigPost | 
    try {
      RelayAutoConfigRep result = apiInstance.postRelayAutoConfig(relayAutoConfigPost);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#postRelayAutoConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
relayAutoConfigPost	RelayAutoConfigPost

Return type

RelayAutoConfigRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Relay auto config response	-
400	Invalid request	-
401	Invalid access token	-
429	Rate limited	-

resetRelayAutoConfig

RelayAutoConfigRep resetRelayAutoConfig(id, expiry)

Reset Relay Proxy configuration key

Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.RelayProxyConfigurationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    RelayProxyConfigurationsApi apiInstance = new RelayProxyConfigurationsApi(defaultClient);
    String id = "id_example"; // String | The Relay Proxy configuration ID
    Long expiry = 56L; // Long | 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 {
      RelayAutoConfigRep result = apiInstance.resetRelayAutoConfig(id, expiry);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RelayProxyConfigurationsApi#resetRelayAutoConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	The Relay Proxy configuration ID
expiry	Long	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

RelayAutoConfigRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Relay auto config response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

FilesExpand file tree

RelayProxyConfigurationsApi.md

Latest commit

History

RelayProxyConfigurationsApi.md

File metadata and controls

RelayProxyConfigurationsApi

deleteRelayAutoConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRelayProxyConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRelayProxyConfigs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchRelayAutoConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postRelayAutoConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

resetRelayAutoConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details