REST API - list

vapi metadata cli command: list

Returns the identifiers of all commands, or commands in a specific namespace.

Request:

HTTP request

GET https://{server}/rest/com/vmware/vapi/metadata/cli/command

?path=string

Request Query Parameters:

Name Type Description
bold = required
path string Optional. The dot-separated path of the namespace for which command identifiers should be returned.

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "path""string",
            "name""string"
        },
        {
            "path""string",
            "name""string"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value identity[] Identifiers of the requested commands.
value[].path string The dot-separated path of the namespace containing the command in the CLI command tree.

value[].name string Name of the command.

Errors:

HTTP Status Code Type Description
404 not_found if a namespace corresponding to path doesn't exist.