1. Operations
  2. vapi
  3. metadata
  4. cli
  5. source

vapi metadata cli source: get

Retrieves information about the metadata source corresponding to source_id.

Request:

HTTP request

GET https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}

Path Parameters

Name Type Description
Required
source_id string Identifier of the metadata source.

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "address": "http://myurl.com",
        "description": "string",
        "filepath": "string",
        "type": "FILE"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/cli/source" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <filepath>string</filepath>
    <address>http://myurl.com</address>
    <description>string</description>
    <type>FILE</type>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value info The vapi.metadata.cli.source.info instance that corresponds to source_id.
value.description string English language human readable description of the source.
value.type string The type (FILE, REMOTE) of the metadata source.

Defines the types of sources for API metadata. You specify the type of source when adding a metadata source to a metadata service. Value is one of:
FILE: Indicates the metadata source is a JSON file.
REMOTE: Indicates the metadata source is a remote server.
value.filepath string Absolute file path of the CLI metadata file that has the CLI information about one component. The filepath is the path to the file in the server's filesystem.

Optional. It is only relevant when type has value FILE. This field is optional and it is only relevant when the value of type is SourceType#FILE.
value.address URI Connection information for the remote server. This should be in the format http(s)://IP:port/namespace.

The remote server must contain the services in the vapi.metadata.cli API. It must expose CLI information of one or more components.

Optional. It is only relevant when type has value REMOTE. This field is optional and it is only relevant when the value of type is SourceType#REMOTE.

Errors:

HTTP Status Code Type Description
404 not_found If the metadata source identifier is not found.