Veeam Management Pack 13 for Microsoft System Center
REST API Reference
Related documents

VmwareServers

The /VmwareServers resource collection represents all VMware servers added to your management server infrastructure.

Get VMware Server Hierarchy Tree

The HTTP GET request to the /vmwareServers/serversTree endpoint retrieves a hierarchical tree of registered VMware servers with their clusters and hosts.

SecurityuserAuth
Responses
200

OK

401

Unauthorized

500

Internal Server Error

get/api/v1/vmwareServers/serversTree
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get VMware Server Data
The HTTP GET request to the /vmwareServers/server/{id} endpoint retrieves the configuration of a registered VMware server with the specified ID.


SecurityuserAuth 
Request 
path Parameters
id
required
string
 
Responses 
200
OK


401
Unauthorized


404
Not Found


500
Internal Server Error


get/api/v1/vmwareServers/server/{id}
Request samples 
Response samples 
application/json
{
  • "proxy": null,
  • "dnsNameOrIp": "vcenter.lab.local",
  • "port": 443,
  • "useProxy": false,
  • "username": "administrator@vsphere.local",
  • "notes": "Production vCenter",
  • "group": "Default",
  • "jobsIds": [
    ],
  • "enableMonitoringNewJobs": true,
  • "acceptedCertThumbprint": null
}
Register VMware vCenter or ESXi Host
The HTTP POST request to the /vmwareServers/server/add endpoint registers a new VMware server or ESXi host for monitoring.
The jobsIds field can contain topology node IDs obtained from the server/getJobs endpoint response. Each ID is a compound value from the id field of the returned job object. If the field is omitted or empty, the server is registered without monitoring jobs.


##Certificate validation


By default, the full SSL certificate chain is validated when the connection to the server is established. If the certificate is not trusted (for example, a self-signed certificate or a certificate issued by an untrusted CA), the request fails with an error.
To add a server with an untrusted certificate, specify the certificate thumbprint in the acceptedCertThumbprint field of the request body.


SecurityuserAuth 
Request 
Request Body schema: application/json
dnsNameOrIp
required
string or null
FQDN or IP address of the VMware server.


 
group
required
string or null
Name of the Collector group to which the monitoring jobs of this server are assigned.


 
password
required
string or null
Password for VMware server authentication.


 
useProxy
required
boolean
Defines whether the connection will be established through a proxy server.


 
username
required
string or null
User name for VMware server authentication.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server. If omitted, the default value 443 will be used.


 
object (ProxySettings) 
Proxy server connection settings.


 
notes
string or null
Optional notes for the VMware server.


 
jobsIds
Array of strings or null
IDs assigned to the monitoring jobs.


 
enableMonitoringNewJobs
boolean or null
Defines whether to monitor newly discovered jobs automatically. 


 
acceptedCertThumbprint
string or null
SHA-1 thumbprint of the VMware SSL certificate. The thumbprint is required when the server uses a self-signed or otherwise untrusted certificate.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/server/add
Request samples 
application/json
{
  • "dnsNameOrIp": "vcenter.lab.local",
  • "port": 443,
  • "useProxy": true,
  • "proxy": {
    },
  • "username": "administrator@vsphere.local",
  • "password": "1234567",
  • "notes": "Production vCenter",
  • "group": "Default",
  • "jobsIds": [
    ],
  • "enableMonitoringNewJobs": true,
  • "acceptedCertThumbprint": "A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0"
}
Response samples 
application/json
{
  • "message": "string"
}
Register VMware vCenter or ESXi Host Without Immediate Connection
The HTTP POST request to the /vmwareServers/server/addDelayed endpoint registers a new VMware vCenter or ESXi host without attempting to connect to it during the request.
Unlike the /vmwareServers/server/add endpoint, this endpoint does not validate connectivity, credentials,or the SSL certificate during registration. The server is saved to the configuration, and the connection is established later by the background monitoring process. Use this endpoint to register servers in bulk or to register a server that is temporarily unreachable.


SecurityuserAuth 
Request 
Request Body schema: application/json
dnsNameOrIp
required
string or null
FQDN or IP address of the VMware server.


 
group
required
string or null
Name of the Collector group to which the monitoring jobs of this server are assigned.


 
password
required
string or null
Password for VMware server authentication.


 
username
required
string or null
User name for VMware server authentication.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server.


 
enableMonitoringNewJobs
boolean
Defines whether to monitor newly discovered jobs automatically. 


 
acceptedCertThumbprint
string or null
SHA-1 thumbprint of the VMware SSL certificate. The thumbprint is required when the server uses a self-signed or otherwise untrusted certificate.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/server/addDelayed
Request samples 
application/json
{
  • "dnsNameOrIp": "vcenter.lab.local",
  • "port": 443,
  • "username": "administrator@vsphere.local",
  • "password": "1234567",
  • "group": "Default",
  • "enableMonitoringNewJobs": true,
  • "acceptedCertThumbprint": "A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0A0"
}
Response samples 
application/json
{
  • "message": "string"
}
Retrieve SSL Certificate
The HTTP POST request to the /vmwareServers/server/validateSslCertificate endpoint connects to a VMware server and validates its SSL certificate chain.


If the certificate is trusted, the untrustedCert field of the response is null. If the certificate is not trusted (for example, a self-signed certificate or a certificate issued by an untrusted CA), the field contains details, including the SHA-1 thumbprint.


SecurityuserAuth 
Request 
Request Body schema: application/json
dnsNameOrIp
required
string or null
FQDN or IP address of the VMware server.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server.


 
Responses 
200
OK


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/server/validateSslCertificate
Request samples 
application/json
{
  • "dnsNameOrIp": "vcenter.lab.local",
  • "port": 443
}
Response samples 
application/json
{
  • "untrustedCert": {
    }
}
Update VMware Server Configuration
The HTTP POST request to the /vmwareServers/server/{id}/save endpoint updates credentials, port, proxy and other settings of a VMware server with the specified ID. To refresh the topology after the update, use the server/getJobs endpoint.


##Certificate validation


By default, the full SSL certificate chain is validated when the connection to the server is established. If the certificate is not trusted (for example, a self-signed certificate or a certificate issued by an untrusted CA), the request fails with an error.
To update a server with an untrusted certificate, specify the certificate thumbprint in the acceptedCertThumbprint field of the request body.


SecurityuserAuth 
Request 
path Parameters
id
required
string
 
Request Body schema: application/json
password
required
string or null
Password for VMware server authentication.


 
useProxy
required
boolean
Defines whether the connection will be established through a proxy server.


 
username
required
string or null
User name for VMware server authentication.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server. If omitted, the default value 443 will be used.


 
object (ProxySettings) 
Proxy server connection settings.


 
acceptedCertThumbprint
string or null
SHA-1 thumbprint of the VMware SSL certificate. The thumbprint is required when the server uses a self-signed or otherwise untrusted certificate.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/server/{id}/save
Request samples 
application/json
{
  • "port": 443,
  • "useProxy": true,
  • "proxy": {
    },
  • "username": "administrator@vsphere.local",
  • "password": "1234567",
  • "acceptedCertThumbprint": null
}
Response samples 
application/json
{
  • "message": "string"
}
Perform VMware Servers Connectivity Check
The HTTP POST request to the /vmwareServers/testAvailability endpoint performs a connectivity check of VMware vCenter or ESXi hosts using the provided credentials. Specify the same port, user name and password for all hosts in the request. Note that this endpoint does not register or modify any server — it only tests connectivity.
The reponse contains one result per host indicating whether the connection succeeded. If the connection failed, the result also contains an error message that describes the reason — for example, invalid credentials, an unreachable network or an unsupported version.


SecurityuserAuth 
Request 
Request Body schema: application/json
hosts
required
Array of strings or null
Information on every returned item.


 
password
required
string or null
Password for VMware server authentication.


 
username
required
string or null
User name for VMware server authentication.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server. If omitted, the default value 443 will be used.


 
Responses 
200
OK


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/testAvailability
Request samples 
application/json
{
  • "hosts": [
    ],
  • "port": 443,
  • "username": "administrator@vsphere.local",
  • "password": "1234567"
}
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Discover Available Monitoring Jobs
The HTTP POST request to the /vmwareServers/server/getJobs endpoint connects to a VMware server that has not been registered yet and discovers the available monitoring jobs (clusters, hosts and datastores). If the server is already registered, the request fails with an error. The request body must contain valid certificate credentials.
Use the returned job IDs later in the request to the /vmwareServers/server/add endpoint.


Certificate validation


By default, the full SSL certificate chain is validated when the connection to the server is established. If the certificate is not trusted (for example, a self-signed certificate or a certificate issued by an untrusted CA), the request fails with an error.
To discover jobs on a server with an untrusted certificate, specify the certificate thumbprint in the acceptedCertThumbprint field of the request body.


SecurityuserAuth 
Request 
Request Body schema: application/json
dnsNameOrIp
required
string or null
FQDN or IP address of the VMware server.


 
password
required
string or null
Password for VMware server authentication.


 
useProxy
required
boolean
Defines whether to connect using a proxy server.


 
username
required
string or null
User name for VMware server authentication.


 
port
integer <int32>   [ 1 .. 65535 ] 
Port used to connect to the VMware server.


 
object (ProxySettings) 
Proxy server connection settings.


 
acceptedCertThumbprint
string or null
SHA-1 thumbprint of the VMware SSL certificate. The thumbprint is required when the server uses a self-signed or otherwise untrusted certificate.


 
Responses 
200
OK


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/server/getJobs
Request samples 
application/json
{
  • "dnsNameOrIp": "vcenter.lab.local",
  • "port": 443,
  • "useProxy": true,
  • "proxy": {
    },
  • "username": "administrator@vsphere.local",
  • "password": "1234567",
  • "acceptedCertThumbprint": null
}
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Remove VMware Servers
The HTTP POST request to the /vmwareServers/servers/delete endpoint removes VMware servers from the configuration. Use the vCenter Server host names (FQDN or IP address) as IDs. You can find these values in the dnsNameOrIp field of the server configuration.


SecurityuserAuth 
Request 
Request Body schema: application/json
ids
required
Array of strings or null
List of Hyper-V server FQDNs.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/servers/delete
Request samples 
application/json
{
  • "ids": [
    ]
}
Response samples 
application/json
{
  • "message": "string"
}
Add VMware Topology to Monitoring
The HTTP POST request to the /vmwareServers/servers/addToMonitoring endpoint adds VMware topology nodes to monitoring.
Use the returned host or cluster IDs later in the request to the /vmwareServers/serversTree endpoint.


SecurityuserAuth 
Request 
Request Body schema: application/json
ids
required
Array of strings or null
List of Hyper-V server FQDNs.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/servers/addToMonitoring
Request samples 
application/json
{
  • "ids": [
    ]
}
Response samples 
application/json
{
  • "message": "string"
}
Remove VMware Topology from Monitoring
The HTTP POST request to the /vmwareServers/servers/removeFromMonitoring endpoint removes VMware topology nodes from monitoring.
Use the returned host or cluster IDs later in the request to the /vmwareServers/serversTree endpoint.


SecurityuserAuth 
Request 
Request Body schema: application/json
ids
required
Array of strings or null
List of Hyper-V server FQDNs.


 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/servers/removeFromMonitoring
Request samples 
application/json
{
  • "ids": [
    ]
}
Response samples 
application/json
{
  • "message": "string"
}
Get Latest Connectivity Test Results
The HTTP GET request to the /vmwareServers/testAvailability endpoint retrieves the results of the most recent connectivity test for all registered VMware servers.


SecurityuserAuth 
Responses 
200
OK


401
Unauthorized


500
Internal Server Error


get/api/v1/vmwareServers/connections
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Start Connectivity Test
The HTTP POST request to the /vmwareServers/connections/startTest endpoint starts a connectivity test for registered VMware servers. If the request body is omitted or empty, the test runs for all registered servers. Otherwise, only the servers specified in the request body are tested. Use the wmwareServers/connections request to retrieve the results.


SecurityuserAuth 
Request 
Request Body schema: 
FQDNs or IP addresses of the VMware servers to test. If omitted or empty, all registered servers are tested.


 Array 
string
 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/connections/startTest
Request samples 
[
  • "string"
]
Response samples 
application/json
{
  • "message": "string"
}
Stop Connectivity Test
The HTTP POST request to the /vmwareServers/connections/stopTest endpoint stops the connectivity test that is currently running.


SecurityuserAuth 
Responses 
204
No Content


401
Unauthorized


500
Internal Server Error


post/api/v1/vmwareServers/connections/stopTest
Request samples 
Response samples 
application/json
{
  • "message": "string"
}

    
    

                                

                                    
Document updated 2026-10-26
Page content applies to build 13.1.0.334