You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

Update TLS configuration for a virtual host

Resource Summary

Security

Content Type

application/json, text/xml

Category

Virtual hosts,

UpdateTLSConfigurationforaVirtualHost

POST

Update TLS configuration for a virtual host

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:

See About virtual hosts for more.


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.

Resource URL

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

Header Parameters

Name Values Description
Content-Type
(required)

Set to application/json or text/xml.

Request Body

Name Description Default Required?
clientAuthEnabled Flag that specifies whether two-way TLS/SSL is enabled between Edge (server) and the app (client) making the request. Enabling two-way TLS requires that you set up a truststore on Edge that contains the certificate from the TLS client. false No
enabled Flag that specifies whether one-way TLS/SSL is enabled. Enabling one-way TLS/SSL requires that you set up a keystore containing the certificate and private key. This flag must be disabled if listening on port 80 and enabled if listening on port 443. false/td> Required to be set to true if listening on port 443
ignoreValidationErrors Flag that specifies whether to ignore TLS certificate errors. This is similar to the -k option to cURL. This option is valid when configuring TLS for Target Servers and Target Endpoints, and when configuring virtual hosts that use 2-way TLS. false No
keyAlias Alias specified when you uploaded the certificate and private key to the keystore. You must specify the alias name literally; you cannot use a reference. N/A Required if enabled is true
keyStore Name of the keystore on Edge. Apigee recommends that you use a reference to specify the keystore name so that you can change the keystore without having to restart Routers. N/A Required if enabled is true
trustStore Name of the truststore on Edge that contains the certificate or certificate chain used for two-way TLS. Apigee recommends that you use a reference to specify the truststore name so that you can change the truststore without having to restart Routers. N/A Required if clientAuthEnabled is true

org_name Organization name. true

env_name Environment name. true

vhost_name 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?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)