- URL:
- https://<root>/security/sslCertificates/importRootOrIntermediate
- Methods:
POST- Version Introduced:
- 10.3
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The import operation imports a certificate authority's (CA) root and intermediate certificates into the keystore.
To create a production quality CA-signed certificate, you need to add the CA certificates into the keystore that enables the SSL mechanism to trust the CA (and the certificates it has signed). While most of the popular CA certificates are already available in the keystore, you can use this operation if you have a custom CA or specific intermediate certificates.
To import a signed certificate from a CA, use the Import Signed Certificate operation.
Request parameters
| Parameter | Details |
|---|---|
| The name of the certificate. Example |
| The multipart POST parameter containing the certificate file. |
| Determines whether the portal should be prevented from restarting after importing the certificate. By default, this value is set as Values: |
| The response format. The default response format is Values: |
JSON Response example
{"status": "success"}