Managing Endpoint Certificates¶
If your api backend is secured with a self-signed certificate (or a certificate which is not signed by a CA) you need to import the backend certificate to the api manager (gateway) client-truststore and restart the server. This feature enables you to upload the backend certificate through API Publisher while creating or editing your API without restarting the server. Follow the steps below to add a certificate to an endpoint.
Note that this feature supports only HTTP/REST and HTTP/SOAP endpoints.
The configurations for the Endpoint Certificates can be modified by adding following config elements to the
<API-M_HOME>/repository/conf/deployment.tomlfile as shown below.
[transport.passthru_https.sender.ssl_profile] interval = 600000
Configuration Parameter Description interval The time taken to load the newly added certificate in milliseconds. Default 10 mins. (600000ms) Minimum interval : 60000ms (1 min)
If you use a different Trust Store/ Keystore configuration for
deployment.tomlfile, modify the KeyStore and TrustStore location in
<API-M_HOME>/repository/resources/security/sslprofiles.xmlfile accordingly. The
sslprofiles.xmlfile is configured with the default client-truststore.jks
This feature currently supports only the following keystore and certificate types.
- Keystore :
- Certificate :
If you need to use a certificate in any other format, you can convert it to
.crt/ .certusing a standard tool before uploading.
The certificate will be added to the Gateway nodes which are defined under the
deployment.toml. In a clustered setup, since gateway configurations are identical, sync the
[API-M_HOME]/repository/resources/security/client-truststore.jksamong the gateway nodes in the cluster. After the configured interval, the synapse transport will be reloaded in all the gateway nodes.
- Keystore :
Adding a Certificate for an Endpoint¶
- Log in to the API Publisher. Create a new API or click on an existing API.
- Go to the Endpoints tab and expand General Endpoint Configuration.
- Enter the following information and click Save .
Name Description Alias Enter a name for your certificate. Endpoint Select an endpoint from the dropdown list Certificate Drop the certificate file or click on the drop zone to select the certificate through the UI
- You can repeat from step 3 to add certificates to the other endpoints.
Check Certificate Information¶
You can check the information of the certificate, i.e: Status and subject DN.
Deleting a certificate¶
To delete a certificate, click the Delete button adjacent to the certificate, as shown below.Top