Skip to content
URL:
https://<root>/security/certificates/trust/import
Methods:
POST
Version Introduced:
10.9

Access requirements

Required privileges

The Enterprise 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 Enterprise 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The import operation imports a trust certificate in either a Privacy Enhanced Mail (PEM) format (.cer or .crt file) or a binary format (.der file). Once a trust certificate is imported, the corresponding pods that will use the certificate are automatically restarted.

Request parameters

ParameterDetails

certificateName

(Required)

A unique, easily identifiable, public-facing name for the certificate.

trustCertificateFile

(Required)

The certificate file (.cer, .crt, or .der).

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the import operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
POST /<context>/admin/security/certificates/trust/import HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=------boundary
Content-Length: []

------boundary
Content-Disposition: form-data; name="certificateName"

TrustCert
------boundary
Content-Disposition: form-data; name="trustCertificateFile"; filename=""
Content-Type: application/octet-stream

certFile.crt
------boundary
Content-Disposition: form-data; name="f"

pjson
------boundary
Content-Disposition: form-data; name="token"

-cvsb6dix1pCO4i-wkOFl5xwVFqn2AjpdsswqOIMZ44b28uoheHJ-ItkLBNhnE_HExIe6wChLpLMh13_RBA07hqgXzxgC8Ex9HqWNMIi5xNtTgqo1KAgnZenWj7sEP8zDY7KslEX_OGeskZ0DkUTsKJAPI5XxFHncZn71n8ca7tQ6E3oDT8orkRvr2Tibe-ccqTBqk3APijlIOEt6oB_PVEg-p45viV9pzI8q9dk6F4uszoL2NkM_amLfK89xqkV
------boundary--

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.