Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Create a Virtual Host

Resource Summary

Security

Content Type

application/json, text/xml

Category

Virtual Host,

createVHost

POST

Create a Virtual Host

Edge on-premises installation only. For an Edge cloud installation, contact Apigee Customer Support.


Creates a virtual host.

Virtual hosts let multiple domain names connect to the same host. A virtual host on Edge defines the domains and ports on which an API proxy is exposed, and, by extension, the URL that apps use to access an API proxy. A virtual host also defines whether the API proxy is accessed by using the HTTP protocol, or by the encrypted HTTPS protocol.

When you create a new API proxy, Edge automatically configures its ProxyEndpoint to use all available virtual hosts. If you create a new API proxy that should not be accessible over a particular virtual host, then you must edit the API proxy to remove that virtual host from its ProxyEndpoint.

If you created any API proxies before requesting the virtual host, then you must edit the API proxy to add the new virtual hosts to its ProxyEndpoint. Otherwise, the API proxy is not accessible by the virtual host.

Note: As of Edge for Private Cloud version 4.16.01, you must create a host alias when you create a virtual host. See the Edge Operations Guide, available on the Apigee ftp site: ftp://ftp.apigee.com/


Also, the combination of host alias name and port number for the virtual host must be unique for all virtual hosts in the Edge installation.

See Virtual hosts for more.

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/virtualhosts

Header Parameters

Name Values Description
Content-Type
(required)

Specify Content Type as either application/json or text/xml

Request Body

Name Description Default Required?
name The name of the virtual host. You use that name to reference the virtual host when configuring an API proxy. The characters that you can use in the name attribute are restricted to: A-Z0-9._\-$ %. N/A Yes
hostAlias The publicly visible DNS name of the virtual host on the Router, optionally including the port number. The combination of host alias name and port number for the virtual host must be unique for all virtual hosts in the Edge installation. You must create a DNS record for the virtual host that matches the host alias, and the host alias must match the string that the client passes in the Host header. Or, you can specify two host aliases, one with the port number and one without. If you specify the port as part of the host alias, you must also specify the same port by using the port element.

You can have multiple host alias definitions in the same virtual host definition, but not multiple ports. If you want multiple ports, create multiple virtual host definitions with different ports.
N/A Yes
interfaces Specifies the network interfaces that you want port to be bound to. If you omit this element, the port is bound on all interfaces. Determine the interfaces available on your system by running the "ifconfig -a" command. All interfaces No
port Specifies the port number used by the virtual host. Ensure that the port is open on the Edge Router. If you specify a port in a host alias element, then the port number specified by port must match it. N/A Yes
enabled Enables one-way TLS. You must have defined a keystore containing the cert and private key. false No
clientAuthEnabled Enables two-way, or client, TLS between Edge (server) and the app (client) making the request. false No
keyStore The name of the keystore on Edge. N/A No
keyAlias The alias specified when you uploaded the JAR file containing the cert and private key to the keystore. N/A No
trustStore The name of the truststore on Edge that contains the certificate or certificate chain used for two-way TLS. N/A No
ciphers Specifies the ciphers supported by the virtual host. If no ciphers are specified, then all ciphers available for the JVM will be permitted. All supported by the JVM No
protocols Specifies the protocols supported by the virtual host. For example, TLSv1, TLSv1.2.

If no protocols are specified, then all protocols available for the JVM will be permitted.
All supported by the JVM No

org_name Mention the organization name true

env_name Mention the environment name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?