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.

Update a Virtual Host

Resource Summary

Security

Content Type

application/json, text/xml

Category

Virtual Host,

updateVHost

PUT

Update a Virtual Host

This API is released for general use in Edge for the Private Cloud, and is in Beta for Edge for the Cloud. See About virtual hosts (Beta) for more on using the API in Eddge for the Cloud.  

 

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. 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 About virtual hosts (Beta) for more information.


A subset of request body properties are valid only for specific Edge for Private Cloud versions, as follows:

  • baseUrl property is valid on Edge for Private Cloud version 4.17.05 and later
  • properties array is valid on Edge for Private Cloud version 4.17.01 and later
  • ciphers and protocols properties are valid on Edge for Private Cloud version 4.15.07 and earlier

Resource URL

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

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. 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
baseUrl Note: Valid for Edge for Private Cloud 4.17.05 and later.

Overrides the URL displayed by the Edge UI for an API proxy deployed to the virtual host. Useful when you have an external load balancer in front of the Edge Routers.
N/A 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 Note: Valid for Edge for Private Cloud 4.15.07 and earlier.

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 Note: Valid for Edge for Private Cloud 4.15.07 and earlier.

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
properties Note: Valid for Edge for Private Cloud 4.17.01 and later.

Specifies the TLS properties supported by the virtual host, such as ssl_ciphers and ssl_protocols. For a complete list, see Virtual host configuration parameters.
Varies per property 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

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?