Platform - proxies

Get proxies

Retrieves an overview of all proxies.

Request

GET /api/v1/platform/infrastructure/proxies

Responses

200

(ProxyOverview) An overview of all proxies.

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies \
-u $CLOUD_USER:$CLOUD_KEY

Get proxies settings

Retrieves the settings for all proxies.

Request

GET /api/v1/platform/infrastructure/proxies/settings

Responses

200

(ProxiesSettings) Settings for all proxies.

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY

Update proxy settings

Applies the settings as a patch. Only the fields that are referenced in the update are changed.

Request

PATCH /api/v1/platform/infrastructure/proxies/settings

Query parameters

Name Type Required Description

version

integer

N

If specified, checks for conflicts against the version of the repository configuration (returned in 'x-cloud-resource-version' of the GET request)

Request body

(string) (required) A JSON to merge with the existing settings

Responses

200

(ProxiesSettings) Returns the updated settings

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
449
(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPATCH {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY

Set proxy settings

Overwrites the proxy settings. All unspecified fields are deleted.

Request

PUT /api/v1/platform/infrastructure/proxies/settings

Query parameters

Name Type Required Description

version

integer

N

If specified, checks for conflicts against the version of the settings (returned in 'x-cloud-resource-version' of the GET request)

Request body

(ProxiesSettings) (required) The proxy settings to apply

Responses

200

(ProxiesSettings) Returns the updated settings

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "http_settings" : {
      "cookie_secret" : "string",
      "dashboards_base_url" : "string",
      "disconnected_cutoff" : 0,
      "minimum_proxy_services" : 0,
      "sso_settings" : {
         "cookie_name" : "string",
         "default_redirect_path" : "string",
         "dont_log_requests" : true,
         "maintenance_bypass_cookie_name" : "string",
         "max_age" : 0,
         "sso_secret" : "string"
      },
      "user_cookie_key" : "string"
   },
   "signature_secret" : "string",
   "signature_valid_for_millis" : 0
}
'

Get proxy

Retrieves a single proxy by ID.

Request

GET /api/v1/platform/infrastructure/proxies/{proxy_id}

Path parameters

Name Type Required Description

proxy_id

string

Y

The identifier for the proxy

Responses

200
(ProxyInfo) The information for the proxy specified by {proxy_id}.
404
(BasicFailedReply) Unable to find the {proxy_id} specified proxy. Edit your request, then try again. (code: 'proxies.proxy_not_found')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/{proxy_id} \
-u $CLOUD_USER:$CLOUD_KEY