Veeam Backup & Replication 13
REST API Reference
Related documents

Connection

The Connection section defines a path and operation for retrieving a TLS certificate or SSH fingerprint used to establish a secure connection between the backup server and the specified server.

Request TLS Certificate or SSH Fingerprint

The HTTP POST request to the /api/v1/connectionCertificate path allows you to get a TLS certificate or SSH fingerprint of the specified host.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
serverName
required
string

Full DNS name or IP address of the server.

type
required
string (EManagedServerType)

Type of the server.

Enum: "WindowsHost" "LinuxHost" "ViHost" "CloudDirectorHost" "HvServer" "HvCluster" "SCVMM" "SmbV3Cluster" "SmbV3StandaloneHost"
credentialsStorageType
string (ECredentialsStorageType)

Credentials type used to connect to the Linux server.

Enum: "Permanent" "SingleUse" "Certificate"
credentialsId
string <uuid>

ID of a credentials record used to connect to the server.

object (LinuxCredentialsSpec)

Settings for single-use credentials.

port
integer

Port used to communicate with the server.

Responses
201

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/connectionCertificate
Request samples
application/json
{
  • "serverName": "vcenter01.tech.local",
  • "credentialsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "type": "ViHost",
  • "port": 443
}
Response samples
application/json
{
  • "fingerprint": null,
  • "certificate": {
    }
}