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

Upload Service Provider Certificate

You can upload a security certificate with a private key, if you want to sign and encrypt authentication requests sent from Veeam Backup for Microsoft Azure to the identity provider.

Request

To upload a certificate, send the HTTP PUT request to the /settings/saml2/sp/certificate endpoint.

HTTP Request

PUT https://<hostname>/api/v3/settings/saml2/sp/certificate

Request Headers

The request contains the following headers.

Header

Required

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.

Request Body

To upload a service provider certificate, send the content of the certificate file and a password in the following format:

{

 "certificatePfxBase64": "string",

 "password": "string"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

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.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a 200 success response code.

Upload Service Provider CertificateExample

The following request returns a 200 response code.

Request:

PUT https://51.11.247.127/api/v3/settings/saml2/sp/certificate

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200