Properties

Spring Boot Admin Client configuration options

Property name	Description	Default value
spring.boot.admin.client.enabled	Enables the Spring Boot Admin Client.	true
spring.boot.admin.client.url	Comma separated ordered list of URLs of the Spring Boot Admin server to register at. This triggers the AutoConfiguration. Mandatory.
spring.boot.admin.client.api-path	Http-path of registration endpoint at your admin server.	"instances"
spring.boot.admin.client.usernamespring.boot.admin.client.password	Username and password in case the SBA Server api is protected with HTTP Basic authentication.
spring.boot.admin.client.period	Interval for repeating the registration (in ms).	10,000
spring.boot.admin.client.connect-timeout	Connect timeout for the registration (in ms).	5,000
spring.boot.admin.client.read-timeout	Read timeout for the registration (in ms).	5,000
spring.boot.admin.client.auto-registration	If set to true the periodic task to register the application is automatically scheduled after the application is ready.	true
spring.boot.admin.client.auto-deregistration	Switch to enable auto-deregistration at Spring Boot Admin server when context is closed. If the value is unset the feature is active if a running CloudPlatform was detected.	null
spring.boot.admin.client.register-once	If set to true the client will only register against one admin server (in order defined by spring.boot.admin.instance.url); if that admin server goes down, will automatically register against the next admin server. If false, will register against all admin servers.	true
spring.boot.admin.client.instance.health-url	Health-url to register with. Can be overridden in case the reachable URL is different (e.g. Docker). Must be unique in registry.	Guessed based on management-base-url and endpoints.health.id.
spring.boot.admin.client.instance.management-base-url	Base url for computing the management-url to register with. The path is inferred at runtime, and appended to the base url.	Guessed based on management.server.port, service-url and server.servlet-path.
spring.boot.admin.client.instance.management-url	Management-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).	Guessed based on management-base-url and management.server.base-path.
spring.boot.admin.client.instance.service-base-url	Base url for computing the service-url to register with. The path is inferred at runtime, and appended to the base url. In Cloudfoundry environments you can switching to https like this: spring.boot.admin.client.instance.service-base-url=https://${vcap.application.uris[0]}	Guessed based on hostname, server.port.
spring.boot.admin.client.instance.service-url	Service-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).	Guessed based on service-base-url and server.context-path.
spring.boot.admin.client.instance.service-path	Service-path to register with. Can be overridden in case the reachable path is different (e.g. context-path set programmatically).	/
spring.boot.admin.client.instance.name	Name to register with.	${spring.application.name} if set, "spring-boot-application" otherwise.
spring.boot.admin.client.instance.service-host-type	Select which information should be considered when sending the host of a service:* IP: Uses the IP returned by InetAddress.getHostAddress()* HOST_NAME: Uses the host name of a single machine returned by InetAddress.getHostName()* CANONICAL_HOST_NAME: Uses the FQDN returned by InetAddress.geCanonicalHostName()If server.address or management.server.address is set in the service, the value will overrule this property.	CANONICAL_HOST_NAME
spring.boot.admin.client.instance.metadata.*	Metadata key-value-pairs to be associated with this instance.
spring.boot.admin.client.instance.metadata.tags.*	Tags as key-value-pairs to be associated with this instance.

Instance metadata options

Key	Value	Default value
user.nameuser.password	Credentials being used to access the endpoints.