Vapi Metadata Cli Namespace get

Vapi Metadata Cli Namespace get

Retreives information about a namespace including information about children of that namespace.

Request
URI
POST
https://{api_host}/api/vapi/metadata/cli/namespace?action=get
COPY
Request Body

Request body for invoking operation: get

{
    "identity": {
        "path": "string",
        "name": "string"
    }
}
identity
Required

The Vapi Metadata Cli Namespace Identity schema uniquely identifies a namespace in the CLI namespace tree.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the namespace including information about child of that namespace.

Returns Vapi Metadata Cli Namespace Info of type(s) application/json
"Vapi Metadata Cli Namespace Info Object"
identity
Required

Basic namespace identity.

string
description
Required

The text description displayed to the user in help output.

array of object
children
Required

The children of this namespace in the tree of CLI namespaces.


404

if a namespace corresponding to identity doesn't exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"identity:"object"}' https://{api_host}/api/vapi/metadata/cli/namespace?action=get