Command Response Documentation

All commands are guaranteed to have structured response format, documented here. If an attribute is marked as optional, its presence is not guaranteed in the resulting JSON respones.

Current version is 1. If the command is at a revision newer than what will be returned by the current version, it is prefixed with a red dot (in search box). The documentation refers to the latest revision of each model. For more info on versioning, see the overview page.

config and exec commands

Response

errors List of strings - optional If running this command produced any configuration errors, this field will be populated with a list of strings, each representing a discrete error.
warnings List of strings - optional If running this command produced any warnings, this field will be populated with a list of strings, each representing a discrete warning.
messages List of strings - optional Occasionally a non-show command will produce an informative message upon completion. If this happens, this field will be populated with a list of strings, each representing a discrete message.
˶