HTTP Endpoint

This is an abstract object type that cannot be instantiated.

The HTTP Endpoint is used to define HTTP endpoint.

HTTP Endpoints

The following HTTP Endpoints are available:

These HTTP Endpoints inherit the properties described below.

Dependencies

HTTP Endpoints depend on the following objects:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

Advanced Properties

  • None

Basic Properties

authorization-mechanism

SynopsisThe HTTP authorization mechanisms supported by this HTTP Endpoint.
Default ValueNone
Allowed ValuesThe name of an existing HTTP Authorization Mechanism. The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled.
Multi-valuedYes
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

base-path

SynopsisAll HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

enabled

SynopsisIndicates whether the HTTP Endpoint is enabled.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the HTTP Endpoint implementation.
Default ValueNone
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.HttpEndpoint
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo