Skip to content
This repository was archived by the owner on Oct 27, 2022. It is now read-only.

Latest commit

 

History

History
63 lines (44 loc) · 1.83 KB

File metadata and controls

63 lines (44 loc) · 1.83 KB

VSphereAutomation::VAPI::RestNavigationServiceApi

All URIs are relative to https://<vcenter>/rest

Method HTTP request Description
list GET /com/vmware/vapi/rest/navigation/service Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.

list

VapiRestNavigationServiceListResult list(component_id, opts)

Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.

Example

# load the gem
require 'vsphere-automation-vapi'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::VAPI::RestNavigationServiceApi.new
component_id = 'component_id_example' # String | Component identifier.
opts = {
  base_url: 'base_url_example' # String | Base URL.
}

begin
  #Gets list of all vAPI REST {@link Service}s for a vAPI REST {@link Component}.
  result = api_instance.list(component_id, opts)
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling RestNavigationServiceApi->list: #{e}"
end

Parameters

Name Type Description Notes
component_id String Component identifier.
base_url String Base URL. [optional]

Return type

VapiRestNavigationServiceListResult

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json