Global

Type Definitions


Configuration

An object for configuring the API manager tools.

Type:
  • object
Properties:
Name Type Argument Description
username string

The API Portal username used for authentication.

password string

The password for the above user.

host string

The hostname of the API Portal.

proxy string <optional>

Optional (https) proxy server URI.

Source:

VirtualHost

An object containing virtual host information

Type:
  • object
Properties:
Name Type Argument Description
id string

The id of the virtual host.

name string

The name of the virtual host.

url string

The base url for the virtual host.

host string

The hostname of the virtual host.

port number <optional>

The port of the virtual host; may be null.

ssl boolean

Flag indicating if the host is on SSL.

projectPath string <optional>

The project path on the host; may be null.

default boolean

Flag indicating if the virtual host is the default one.

Source: