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

Annotation Interface WebEndpoint

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Endpoint
@FilteredEndpoint(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	Description
String	id	The id of the endpoint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Access	defaultAccess	Level of access to the endpoint that is permitted by default.
boolean	enableByDefault	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 4.0.0 in favor of defaultAccess()

Element Details

id

@AliasFor(annotation=Endpoint.class)
String id

The id of the endpoint.

Returns:

the id

enableByDefault

@Deprecated(since="3.4.0",
            forRemoval=true)
@AliasFor(annotation=Endpoint.class)
boolean enableByDefault

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 4.0.0 in favor of defaultAccess()

If the endpoint should be enabled or disabled by default.

Returns:

true if the endpoint is enabled by default

Default:

true

defaultAccess

@AliasFor(annotation=Endpoint.class)
Access defaultAccess

Level of access to the endpoint that is permitted by default.

Returns:

the default level of access

Since:

3.4.0

Default:

UNRESTRICTED