Retrieves an overview of all proxies.
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Retrieves the settings for all proxies.
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Applies the settings as a patch. Only the fields that are referenced in the update are changed.
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | If specified, checks for conflicts against the version of the repository configuration (returned in 'x-cloud-resource-version' of the GET request) |
-
200 (
ProxiesSettings) Returns the updated settingsHeaders
-
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"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Overwrites the proxy settings. All unspecified fields are deleted.
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | If specified, checks for conflicts against the version of the settings (returned in 'x-cloud-resource-version' of the GET request) |
(ProxiesSettings) (required) The proxy settings to apply
-
200 (
ProxiesSettings) Returns the updated settingsHeaders
-
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"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
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
}
'Retrieves a single proxy by ID.
-
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')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.