HostConfig

get/api/v1/config/host/{id}

Path parameters

idinteger required

Response

OK

idinteger
bindAddressstring nullable
portinteger
sslPortinteger
enableSslboolean
launchBrowserboolean
authenticationMethod'none' | 'basic' | 'forms' | 'external'
authenticationRequired'enabled' | 'disabledForLocalAddresses'
analyticsEnabledboolean
usernamestring nullable
passwordstring nullable
passwordConfirmationstring nullable
logLevelstring nullable
logSizeLimitinteger
consoleLogLevelstring nullable
branchstring nullable
apiKeystring nullable
sslCertPathstring nullable
sslCertPasswordstring nullable
urlBasestring nullable
instanceNamestring nullable
applicationUrlstring nullable
updateAutomaticallyboolean
updateMechanism'builtIn' | 'script' | 'external' | 'apt' | 'docker'
updateScriptPathstring nullable
proxyEnabledboolean
proxyType'http' | 'socks4' | 'socks5'
proxyHostnamestring nullable
proxyPortinteger
proxyUsernamestring nullable
proxyPasswordstring nullable
proxyBypassFilterstring nullable
proxyBypassLocalAddressesboolean
certificateValidation'enabled' | 'disabledForLocalAddresses' | 'disabled'
backupFolderstring nullable
backupIntervalinteger
backupRetentioninteger
trustCgnatIpAddressesboolean

Changes

Changed in 5 of the 50 revisions of this API.1515

    • added the optional property trustCgnatIpAddresses to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property trustCgnatIpAddresses to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property trustCgnatIpAddresses to the response with the 200 status (media type: text/json)

      response-optional-property-added

    • added the optional property logSizeLimit to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property logSizeLimit to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property logSizeLimit to the response with the 200 status (media type: text/json)

      response-optional-property-added

    • added the optional property passwordConfirmation to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property passwordConfirmation to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property passwordConfirmation to the response with the 200 status (media type: text/json)

      response-optional-property-added

  • ce270821acc733See the full diff
    • added the new external enum value to the authenticationMethod response property for the response status 200 (media type: text/plain)

      response-property-enum-value-added

    • added the new external enum value to the authenticationMethod response property for the response status 200 (media type: application/json)

      response-property-enum-value-added

    • added the new external enum value to the authenticationMethod response property for the response status 200 (media type: text/json)

      response-property-enum-value-added

    • added the optional property authenticationRequired to the response with the 200 status (media type: text/plain)

      response-optional-property-added

    • added the optional property authenticationRequired to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • added the optional property authenticationRequired to the response with the 200 status (media type: text/json)

      response-optional-property-added

  • bf5343db433b123See the full diff
    • removed the optional property authenticationRequired from the response with the 200 status (media type: text/plain)

      response-optional-property-removed

    • removed the optional property authenticationRequired from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property authenticationRequired from the response with the 200 status (media type: text/json)

      response-optional-property-removed

    • removed the optional property logSizeLimit from the response with the 200 status (media type: text/plain)

      response-optional-property-removed

    • removed the optional property logSizeLimit from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property logSizeLimit from the response with the 200 status (media type: text/json)

      response-optional-property-removed

    • removed the optional property passwordConfirmation from the response with the 200 status (media type: text/plain)

      response-optional-property-removed

    • removed the optional property passwordConfirmation from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property passwordConfirmation from the response with the 200 status (media type: text/json)

      response-optional-property-removed

    • removed the optional property trustCgnatIpAddresses from the response with the 200 status (media type: text/plain)

      response-optional-property-removed

    • removed the optional property trustCgnatIpAddresses from the response with the 200 status (media type: application/json)

      response-optional-property-removed

    • removed the optional property trustCgnatIpAddresses from the response with the 200 status (media type: text/json)

      response-optional-property-removed

    • removed the external enum value from the authenticationMethod response property for the response status 200 (media type: text/plain)

      response-property-enum-value-removed

    • removed the external enum value from the authenticationMethod response property for the response status 200 (media type: application/json)

      response-property-enum-value-removed

    • removed the external enum value from the authenticationMethod response property for the response status 200 (media type: text/json)

      response-property-enum-value-removed

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog