api https enable

Function

The api https enable command enables the HTTPS-based RESTCONF interface service.

The undo api https enable command disables the HTTPS-based RESTCONF interface service.

Format

api https [ port port-number ] enable

undo api https enable

Parameters

Parameter	Description	Value
port port-number	Specifies the https service port.	The value is an integer ranging from 1025 to 50000. The default port is 8447.

Views

API view

Default Level

3: Management level

Usage Guidelines

You are advised to use the default port. If you must user a user-defined port, ensure that this port is used by the API service only.

By default, the HTTPS-based RESTCONF interface service is disabled on the FW.

After the HTTPS-based RESTCONF interface service is enabled, it is not recommended that the administrator log in to the device through the web UI or CLI to configure the device. Otherwise, the administrator and the northbound API user may deliver configurations at the same time, causing configuration inconsistency between the northbound API controller and device.

Example

# Enable the HTTPS-based RESTCONF interface service and set the port to 8450.

<sysname> system-view
[sysname] api
[sysname-api] api https port 8450 enable