Set proxy settings

PUT /platform/infrastructure/proxies/settings

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

Overwrites the proxy settings. All unspecified fields are deleted.

Query parameters

  • version string

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

application/json

Body Required

The proxy settings to apply

  • 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

    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

      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

      • 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

    • dashboards_base_url string Required

      Base URL for the dashboard

Responses

  • 200 application/json

    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

      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

        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

        • 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

      • dashboards_base_url string Required

        Base URL for the dashboard

  • 409 application/json

    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

PUT /platform/infrastructure/proxies/settings
curl \
 --request PUT 'https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"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"}}'