Was this helpful?

 

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/environments/{environment_name}/virtualhosts/{virtualhost_name}

Description: Gets details for a named virtual host

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml

Overview: Every environment in Apigee has at least one virtual host. The virtual host defines the HTTP settings for connection with the Apigee organization. All API proxies in an environment share the same virtual hosts. This method returns the list of named virtual hosts. You can use the names here to get details for the virtual host. This is the best way to verify the network address that client apps must use to invoke your APIs. By default, two virtual hosts are available for each environment: 'default' and 'secure'.

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/(env_name)/virtualhosts/{virtualhost_name}\
-u myname:mypass
Sample Response:
{
    "VirtualHost": {
        "name": "default", 
        "HostAliases": {
            "HostAlias": "myorg-test.apigee.net"
        }, 
        "Interfaces": "", 
        "Port": 80
    }
}
Response Payload Elements:
Name Description
VirtualHost Settings for a named virtual host
name The name of the virutal host
HostAliases The URL for the virtual host
Interfaces Named interfaces used by the virtual host
Port The port on which the virtual host listens

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)