Virtual hosts API

Manage virtual hosts. 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.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

SSLInfo

For more information, see SSLInfo.
MethodEndpointDescription
post/organizations/{org_name}/environments/{env_name}/virtualhosts

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.

The request body content used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see Virtual host property reference.

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

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

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.

For a general introduction to creating virtual hosts, see About virtual hosts. For information about your specific version of Edge, see:

Updating a proxy to use the new virtual host

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. See Configuring an API proxy to use a virtual host.

get/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Gets a virtual host.

Every environment has at least one virtual host that defines the HTTP settings for connection with the Apigee organization. All API proxies in an environment share the same virtual hosts. By default, two virtual hosts are available for each environment: default and secure.

put/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

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. You can get the current virtual host properties, as described in Get a virtual host.

The request body used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see Virtual host property reference.

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

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

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.

For a general introduction to creating virtual hosts, see About virtual hosts. For information about your specific version of Edge, see:

For complete information on setting all virtual host values, see Virtual host property reference.

post/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}/sslinfo

DEPRECATED: This API is being deprecated and will be removed in a future release.

Cloud customers can now create and update a virtual host, not just modify the TLS properties of the virtual host. Therefore, this API has been deprecated. Cloud customers can now use the following APIs with virtual hosts:

Update the TLS configuration properties for a virtual host for Edge in the Cloud. For example, enable one-way or two-way TLS or specify the keystore/truststore used by the virtual host.

Only paid Edge Cloud accounts can make modifications to the TLS configuration of virtual hosts. Edge trial accounts cannot modify the TLS configuration of virtual hosts. Trial accounts must upgrade to a paid account to enable this feature.

VirtualHost

For more information, see VirtualHost.
MethodEndpointDescription
post/organizations/{org_name}/environments/{env_name}/virtualhosts

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.

The request body content used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see Virtual host property reference.

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

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

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.

For a general introduction to creating virtual hosts, see About virtual hosts. For information about your specific version of Edge, see:

Updating a proxy to use the new virtual host

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. See Configuring an API proxy to use a virtual host.

get/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Gets a virtual host.

Every environment has at least one virtual host that defines the HTTP settings for connection with the Apigee organization. All API proxies in an environment share the same virtual hosts. By default, two virtual hosts are available for each environment: default and secure.

put/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

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. You can get the current virtual host properties, as described in Get a virtual host.

The request body used to create a virtual host depends on whether you are using Edge for the Cloud or Edge for the Private Cloud. If you are using Edge for the Private Cloud, then it also depends on which version of Edge for the Private Cloud you are using. For a complete list of all options for the request body, see Virtual host property reference.

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

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

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.

For a general introduction to creating virtual hosts, see About virtual hosts. For information about your specific version of Edge, see:

For complete information on setting all virtual host values, see Virtual host property reference.

post/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}/sslinfo

DEPRECATED: This API is being deprecated and will be removed in a future release.

Cloud customers can now create and update a virtual host, not just modify the TLS properties of the virtual host. Therefore, this API has been deprecated. Cloud customers can now use the following APIs with virtual hosts:

Update the TLS configuration properties for a virtual host for Edge in the Cloud. For example, enable one-way or two-way TLS or specify the keystore/truststore used by the virtual host.

Only paid Edge Cloud accounts can make modifications to the TLS configuration of virtual hosts. Edge trial accounts cannot modify the TLS configuration of virtual hosts. Trial accounts must upgrade to a paid account to enable this feature.