In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to

Test a Keystore or Truststore

Resource Summary


Content Type

application/json, text/xml


Keystores and Truststores,



Test a Keystore or Truststore

Test your truststore and keystore in the Edge UI to verify that they are configured properly. The test API validates a TLS request from Edge to a backend service. The backend service can be configured to support one-way or two-way TLS.

Resource URL /organizations/{org_name}/environments/{env_name}/testssl

Request Body

Name Description Default Required?
host The TLS host name.   Yes
port The TLS port number.   Yes
connectionTimeout The TLS connection timeout, in milliseconds. The default value is 3000. 3000 No
clientAuthEnabled Set to false for one-way TLS and to true for two-way TLS.   Yes
keystore The name of the keystore.   Required for two-way TLS.
keyAlias The name of the keystore alias.   Required for two-way TLS.
trustStore The name of the trsutstore.   Required for both one-way and two-way TLS.
ciphers The list of TLS ciphers to whitelist.   No
protocol The TLS protocol, such as SSLv3, TLSv1, TLSv1.1, TLSv1.3.   No

org_name Mention the organization name true

env_name Mention the environment 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?

  • 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?)