This is an archive version of the document. To get the most up-to-date information, see the current version.

Upload Own Security Certificate

You can upload a security certificate that you obtained from a CA or generated using a 3rd party tool.

Note

After you replace the existing security certificate, the Veeam Backup for AWS REST API and Web UI services will be restarted automatically.

Request

To upload own security certificate, send the HTTP POST request to the /settings/certificates/upload endpoint.

HTTP Request

POST https://<hostname>:<port>/api/v1/settings/certificates/upload

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

Content-Type

Required

multipart/form-data; boundary=--Random

Identifies a media type that is used in the body of the request.

Request Body

To upload and replace the certificate send the certificateFile and specify the certificatePassword you used to protect the file.

--Random

Content-Disposition: form-data; name="certificateFile"; filename="FILE_NAME.pfx"

Content-Type: application/x-pkcs12

 

<@INCLUDE *FILE_PATH\FILE_NAME.pfx*@>

 

--Random

Content-Disposition: form-data; name="certificatePassword"

 

passwordValue

--Random--

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns a response code 202 (Accepted).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Upload Own Security CertificateExample

The following request uploads the security certificate.

Request:

POST https://135.169.170.192:11005/api/v1/settings/certificates/upload

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

Content-Type: multipart/form-data; boundary=Random

 

Request Body:

--Random

Content-Disposition: form-data; name="certificateFile"; filename="TLScert.pfx"

Content-Type: application/x-pkcs12

 

<@INCLUDE *C:\Users\administrator\TLScert.pfx*@>

 

--Random

Content-Disposition: form-data; name="certificatePassword"

 

Administrator123

--Random--

 

 

Response:

202