Send Docs Feedback

Update a Virtual Host

Resource Summary


Content Type

application/json, text/xml


Virtual Host,



Update a Virtual Host

Apigee Edge for Private Cloud installation only. For use in Edge cloud, contact Apigee Customer Support.

Updates a virtual host.

You must specify the complete description of the virtual host in the request body, not just the elements that you want to change.

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:

See Virtual hosts for more.

Resource URL /organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Header Parameters

Name Values Description

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. You must create a DNS record for the virtual host that matches the host alias. While the port number is optional, it is recommended that you specify it. 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

virtualhost_name Mention the virtual host name true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?