org.springframework.boot.actuate.endpoint.web.annotation

Annotation Type WebEndpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Endpoint
 @FilteredEndpoint(value=org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointFilter.class)
public @interface WebEndpoint

Identifies a type as being an endpoint that is only exposed over HTTP.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The id of the endpoint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	enableByDefault If the endpoint should be enabled or disabled by default.

Element Detail

id

@AliasFor(annotation=Endpoint.class)
public abstract String id

The id of the endpoint.

Returns:

the id

enableByDefault

@AliasFor(annotation=Endpoint.class)
public abstract boolean enableByDefault

If the endpoint should be enabled or disabled by default.

Returns:

true if the endpoint is enabled by default

Default:

true