Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
193 lines (118 loc) · 5.61 KB

RelayProxyConfigurationsApi.md

File metadata and controls

193 lines (118 loc) · 5.61 KB

RelayProxyConfigurationsApi

All URIs are relative to /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

Delete a relay proxy configuration by ID.

Example

 deleteRelayProxyConfig id=value

Parameters

Name Type Description Notes
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

Get a single relay proxy configuration by ID.

Example

 getRelayProxyConfig id=value

Parameters

Name Type Description Notes
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

Returns a list of relay proxy configurations in the account.

Example

 getRelayProxyConfigs

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

Modify a relay proxy configuration by ID.

Example

 patchRelayProxyConfig id=value

Parameters

Name Type Description Notes
id string The relay proxy configuration ID
patchDelta array[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

Create a new relay proxy config.

Example

 postRelayAutoConfig

Parameters

Name Type Description Notes
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

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

Example

 resetRelayProxyConfig id=value  expiry=value

Parameters

Name Type Description Notes
id string The relay proxy configuration ID
expiry integer 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

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]