Update proxy settings

PATCH /platform/infrastructure/proxies/settings

WARNING This endpoint is deprecated and scheduled to be removed in the next major version.

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

Query parameters

version string

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

Body Required

A JSON to merge with the existing settings

string string

Responses

200

Returns the updated settings
Hide response attributes Show response attributes object
- expected_proxies_count integer(int32) Required
  
  Expected number of proxies
- signature_secret string Required
  
  Secret string for signature generation
- signature_valid_for_millis integer(int64) Required
  
  Signature validity in milliseconds
- http_settings object Required
  
  HTTP settings
  
  Additional properties are allowed.
  
  Hide http_settings attributes Show http_settings attributes object
  
  disconnected_cutoff integer(int64) Required
  
  Cutoff interval after disconnection in milliseconds
  
  minimum_proxy_services integer(int32) Required
  
  Minimum number of proxy instances
  
  sso_settings object Required
  
  Settings related to single-sign-on
  
  Additional properties are allowed.
  
  Hide sso_settings attributes Show sso_settings attributes object
  
  max_age integer(int64) Required
  
  Maximum age of single-sign-on token in milliseconds
  
  sso_secret string Required
  
  Secret string for single-sign-on
  
  cookie_name string Required
  
  Name of the HTTP cookie used for single-sign-on
  
  dont_log_requests boolean Required
  
  If true, don't log requests
  
  default_redirect_path string Required
  
  Default path where users are redirected after a successful single-sign-on
  
  maintenance_bypass_cookie_name string Required
  
  Name of the cookie that bypasses maintenance
  
  dashboards_base_url string Required
  
  Base URL for the dashboard
  
  cookie_secret string Required
  
  Secret string for the HTTP cookie
  
  user_cookie_key string Required
  
  User key for the HTTP cookie
409

There is a version conflict. (code: proxies.version_conflict)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is proxies.version_conflict.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

PATCH /platform/infrastructure/proxies/settings

curl \
 -X PATCH https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings \
 -d '"string"'

Request examples

string

Response examples (200)

{
  "expected_proxies_count": 42,
  "signature_secret": "string",
  "signature_valid_for_millis": 42,
  "http_settings": {
    "disconnected_cutoff": 42,
    "minimum_proxy_services": 42,
    "sso_settings": {
      "max_age": 42,
      "sso_secret": "string",
      "cookie_name": "string",
      "dont_log_requests": true,
      "default_redirect_path": "string",
      "maintenance_bypass_cookie_name": "string"
    },
    "dashboards_base_url": "string",
    "cookie_secret": "string",
    "user_cookie_key": "string"
  }
}

Response examples (409)

# Headers
x-cloud-error-codes: proxies.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}