API path commands

API path mode provides the commands to create or modify an API path configuration.

To enter API path mode, use the global api-path command. To delete an API path configuration, use the no api-path command.

While in this mode, use the commands in the following table to define the API path configuration.

  • To view the current configuration, use the show command.
  • To restore default values, use the reset command.
  • To exit this configuration mode without saving changes to the running configuration, use the cancel command.
  • To exit this configuration mode and save changes to the running configuration, use the exit command.
Table 1. API path commands
Command Purpose
admin-state This command sets the administrative state for the configuration.
operation This command specifies the operations that users can execute under the path.
parameter This command defines a parameter that applies to all API operations under an API path.
path This command specifies the path to access the REST APIs.
request-schema This command specifies the name of the API schema that describes the valid request messages for the API path.
   
summary This command specifies the brief, descriptive summary for the object instance.