Skip to content

Latest commit

 

History

History
176 lines (110 loc) · 6.55 KB

RelayProxyConfigurationsApi.md

File metadata and controls

176 lines (110 loc) · 6.55 KB

\RelayProxyConfigurationsApi

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

Method HTTP request Description
DeleteRelayProxyConfig Delete /account/relay-auto-configs/{id} Delete a relay proxy configuration by ID.
GetRelayProxyConfig Get /account/relay-auto-configs/{id} Get a single relay proxy configuration by ID.
GetRelayProxyConfigs Get /account/relay-auto-configs Returns a list of relay proxy configurations in the account.
PatchRelayProxyConfig Patch /account/relay-auto-configs/{id} Modify a relay proxy configuration by ID.
PostRelayAutoConfig Post /account/relay-auto-configs Create a new relay proxy config.
ResetRelayProxyConfig Post /account/relay-auto-configs/{id}/reset Reset a relay proxy configuration's secret key with an optional expiry time for the old key.

DeleteRelayProxyConfig

DeleteRelayProxyConfig(ctx, id) Delete a relay proxy configuration by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The relay proxy configuration ID

Return type

(empty response body)

Authorization

Token

HTTP request headers

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

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

GetRelayProxyConfig

RelayProxyConfig GetRelayProxyConfig(ctx, id) Get a single relay proxy configuration by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The relay proxy configuration ID

Return type

RelayProxyConfig

Authorization

Token

HTTP request headers

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

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

GetRelayProxyConfigs

RelayProxyConfigs GetRelayProxyConfigs(ctx, ) Returns a list of relay proxy configurations in the account.

Required Parameters

This endpoint does not need any parameter.

Return type

RelayProxyConfigs

Authorization

Token

HTTP request headers

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

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

PatchRelayProxyConfig

RelayProxyConfig PatchRelayProxyConfig(ctx, id, patchDelta) Modify a relay proxy configuration by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The relay proxy configuration ID
patchDelta []PatchOperation Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

RelayProxyConfig

Authorization

Token

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

RelayProxyConfig PostRelayAutoConfig(ctx, relayProxyConfigBody) Create a new relay proxy config.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
relayProxyConfigBody RelayProxyConfigBody Create a new relay proxy configuration

Return type

RelayProxyConfig

Authorization

Token

HTTP request headers

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

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

ResetRelayProxyConfig

RelayProxyConfig ResetRelayProxyConfig(ctx, id, optional) Reset a relay proxy configuration's secret key with an optional expiry time for the old key.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The relay proxy configuration ID
optional *RelayProxyConfigurationsApiResetRelayProxyConfigOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RelayProxyConfigurationsApiResetRelayProxyConfigOpts struct

Name Type Description Notes

expiry | optional.Int64| 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 |

Return type

RelayProxyConfig

Authorization

Token

HTTP request headers

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

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