api-key

Function

The api-key command sets an API key value for interworking with a local sandbox.

The undo api-key command cancels the setting.

Format

api-key api-key-value

undo api-key

Parameters

Parameter	Description	Value
api-key-value	Specifies an API key value.	The value is a string of 1 to 32 characters. To enhance security, the key value must meet the minimum strength requirements, that is, the password needs to contain at least three types of the following characters: uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as exclamation points (!), number signs (#), dollar signs ($), and percent (%).

Parameter

Description

Value

api-key-value

Specifies an API key value.

The value is a string of 1 to 32 characters.

To enhance security, the key value must meet the minimum strength requirements, that is, the password needs to contain at least three types of the following characters: uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as exclamation points (!), number signs (#), dollar signs ($), and percent (%).

Views

Local sandbox view

Default Level

2: Configuration level

Usage Guidelines

When the FW initiates a connection to a local sandbox, the local sandbox uses the API key value to authenticate the FW.

The API key value is obtained from the administrator of the sandbox. The FW and local sandbox must have the same API key value.

Example

# Configure an API key value for a local sandbox.

<sysname> system-view
[sysname] sandbox default
[sysname-sandbox-default] api-key Admin@123