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)

application/json

Body Required

A JSON to merge with the existing settings

string string

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

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

      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

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

        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

PATCH /platform/infrastructure/proxies/settings
curl \
 --request PATCH 'https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '"string"'