REST API - get

vapi metadata routing source: get

Get the details about a metadata source.

Request:

HTTP request

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

Path Parameters

Name	Type	Description
Required
source_id	string	Metadata source identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "address" : "http://myurl.com",
        "filepath" : "string",
        "description" : "string",
        "type" : "FILE"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Metadata source info.
value.description	string	Description of the source.
value.type	string	Type 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 file that has the metadata information. 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 FILE.
value.address	URI	URI of the remote vAPI endpoint. This should be of the format http(s):IP:port/namespace. 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 REMOTE.

Errors:

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