Veeam Service Provider Console 9.1
REST API Reference
Related documents

Authentication

This resource collection allows to authenticate to Veeam Service Provider Console REST API.

Obtain RSA Keys

Issues an RSA key pair.

You can specify the key size if needed.

Request
query Parameters
keySize
integer <int32>

Number of bits in a key.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

RSA key pair in the .NET XML format.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/authentication/keys/rsa
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
GenerateNewPkcs12KeyPair
Issues a PKCS#12 container with an RSA private key and an X.509 certificate.


Request 
query Parameters
subject
required
string
Certificate subject.


 
keySize
integer <int32> 
RSA key size.


 
password
string or null <password> 
Certificate password.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
Pair of PKCS#12 containers with private and public keys in the Base64 format.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/authentication/keys/rsa-pkcs12
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
DecryptPkcs12Container
Decrypts an encrypted PKCS#12 container.




If container does not include private key the server will return an error with the 1210 code.




Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
certificateContent
required
string
Certificate content.


 
password
string or null <password> 
Certificate password.


 
Responses 
200
Pair of PKCS#12 containers with private and public keys in the Base64 format.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/authentication/keys/rsa-pkcs12/decrypt
Request samples 
application/json
{
  • "certificateContent": "MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQC7DUUQbElwvsOUK4BOSfjKvW23LfTg+q/MnUKpcQBcoBsHrPdOG9fEO43bRll76ZXAOQvmni1EjC6tU8dAkACti/TLF9UpYr7OE/a92hP8Mdm8Z43HX7iYRRKA4cEzUgoMI+Q9MEvPJo+ZvPZtwvrCgRJFeQV9nX38T8jWIt6fG1ML0Zdozy9XRSAqtBaeyNM2eeYQbRagR4my+eEyyjmMS25nzw3lp0P2BGAx234g+GxyGbmfNqTvDx62KRhIjG74+dwOlmAbFs54vYem5wXewNX19fRB2DqvnUZKNzfmMjAkwlpWxX+e/pjCZC0UnvXIvg+Ah9erwqLbyqjGCWFXEL+7CRcqTb/puhQVIGYeJrsItkePgSa59nnZuWXvWI8w0rpW5FqwBwqiDjZFtFuyDhjlvSqiJfUwlOhCxdvQDMQDS8LvpV21imE9sAYQbhXP5WtU+wpMvzE0zrg1GJBUVdkOwtR+inufRnFMV0GGZc8yLIxivOzdB8unV9skDOVz2N6Fn9znMaa0b5Vo0+hHakFRT4l27Wv5gPpeoGD2Ww0Nq/DZbPtKutGXDNnIhigXFD0vDTPSM6r6bpwFYK9ljJqMGMrdiKE+NZ7TWiA/41IyO9QDoiEDHRBkYkJGNiUWHiKvpXB4klvbP7MshNItczb4PrPmumS5lm7cdnKCTQIDAQABAoICABdIuZYnxKSSOopRN/GG579lASlSQS9YRVX1JX0uIdtl2reD4m0Irj0xJKFtCmqQUyHQeBjHC9+Ci7TrvtvckRkJWPmHB/PU5OeGOKq9YMt98Rqw0UdGNRZPUtRURdZ7meCU/y5WurkYlbuPeCWFpe1cX8fiHrraRfqIe/mb8ZZgsl/AQVa8o6n7Ytut+zrcyN35Iphc2/orrYpn7I6D+dHq+d1WOuahgaY4OTk7l2HHSsiRRzf4d2OCwFHwn6M4SAAaKjhuo5v7pMwG28H89BAcdQXfDf68SeHedAd9BCpViQSqZNB0WUSTcLSR/8KXXwUUE53uSvyIh/lQKt4sAL+9NibIrFWh20vgU0k4+0Y4l03GA91nzk9L0DFZT+S7/nycO6Ggi0jgS6C1LjFJ6tONDGjWJyYtQtLamer+fDgua1pNO+oMiCHNpuLBq+AP+qFgZH8EnfgbfG6RsdwYdZ3fX1L+Pf07CvvowADTKzqLYzjXCZbXSXuriSia7mfQtFtG4TwtjXZqxRNjMaYmSqM8Oe1UFg0E+77AP2tm/6CGFWFV/QUsWhsQ0U6qw06cM1npUff2QjxnskSl7smN9vy8DtaAAw3rPGzu4C75yjFdhNqEKqiBm04kVW7qHKCbfU5iGIV8cysbGG26iS7dddzaYnPSeBZM6IKA45hZBjEJAoIBAQDnxib7UYQ1Q4B6wnql49wuu2dJKDCICu8kaDyZzZvgZRg6YX+ngaiIM0gSl+CknPYlhl168Bu1Wav6MEMRz10AljaCyJsO56W6FYRPXpso2/tGWR5mGXUgu471XRFMHZXVOx7RKP0tSD3JUgFdvugjCvJdMvnMQ49SGhsonr0TndbHR9sVlsPK9UK9sA24U3iWW8DO7SSEyFqT0aIBMzzg3YEjgGxwBA07yXnA9gCt9bHvtPCR7n49aIRcb660y9+0ekAFAZwNlOPHiHB3FwdikzHesOXPZBAQ/I/0idRYfgGihjbSPA26DEU2/XUitg8ZfC5f8/hLxl9K1R8efKYnAoIBAQDOmm7/zdxgoaLvo6VD1C9lV5v8yunfUqxQrDgYNos0SDO/cHFvR1FQojmCpqoYNs++pk4wB01gspw4aV9mgFjbPYe66aicKq0JEolZKnKTh3xJB9A/TfTBxtuxjWrlb5iAVA6FoNpDZj/rlVvSCD6IH89Fs7nfpKEWIWHhkcu7dIz2leE+GBKzFqv9rZUZrHvEvCgRi0d0ulkzIbf24q2P11Nw1H4EFJFQs+fypSpUxxI3DOEmSXMHz7loHCmV9+Xl0kS1KEb+lVqj5qFVmZipOEDpjur6mM6oTTdqiLlou4s+lGOU3PF1OgiKqH4gIDAqrlsBlatfZ7TwuGQEGHBrAoIBAQDAC2k7brTsaW0oysJTeHV152RSstFbuCuk8BXenwZcrYegwC7E/eNGT6+VcHD8FO7D8wy8E/3xi0a7vIemVzrJhK3QOiZ4+CpTAQcruMk51uTiym8szEVIBQEUf7QYbJ89GoqTZrI5dhV0HdXx9oBkoOpnnRhsT0KPFgCQ7M7gVTWk0/5Nain7nrNZd2o25DsT4xzkmIxc1aJvvxDMi8cSz5b0crHnMwRAGNYgs/WmLuHsK/H2CTZi7ZpW+Vc6iX9oDK/FNis2+bqvF3eQxe0hmbOFwO/6ov/JA2zIg/gGBwqVvz3nf0kkcoxbXzJSu6XRSRsn+IAxUUKeP+9UFJabAoIBAQCLvHwy2+OgH/L6Li7LL6pW2uiQFBYWi+4sKi9OgSWp2OPXKZAveYcQCIjpSxxkgD4GbqkXZvj43BU5OlviEhEHSBiTXRJDfcHHDxiCjGkuS0bOhlBdYLaYkY1qC4IvaEk3EqM30lGNoIy/JCgUaKsSmqEwPZ0MHGcvdqijTl8DjJMC/OB5hQKwyjbNvyfHU5fqunBHXXKZCqjmInowq6REU5kGCVKqI9cdRHEu9nMpH/O79CQcJzV8JQz704B1BFQkGxGJjZJnAlFp5cVdBiPw4DFXRui7UbsEriU7EvqEUcSeMPMhbkaJyRSZ49haliq902uOKNLeFmCVJ8HN21G9AoIBADXSy4Brlnkxp+AY/PJZab+MdyoqrLDZGtTiFnCm/VUldKD4DCfh9u+s3WPa5T3DZs/fTc7PJ9kE8zA1BTdf0sdJRjtsEYRLk8QnFn7YEy7wbvtlhPfgfkGCFEAINPWsvMOCQFdwZAzw4gVi4GFymPo6lWxP+GFXex3Qq8cinot0xPHZvUD16EwTnWjLeEpE1GaLA2PQIbbfUImvO++6ihgwO1x6hKBALCrDyvutq0YZtrWVM9oz8OYEpLJ+eSwx122yCwkMWKHhRrBcLc1CcaZ7Fq7vzM4hLMsMStWNpjzqm953h/jBMYO02xhuZuElnLQ1KyY2ANF8Urr3LPN6uDY=",
  • "password": "321"
}
Response samples 
application/json
{
  • "data": {
    }
}
Obtain TOTP Secret
Issues a TOTP secret and a URL-encoded secret.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
TOTP secret and URL-encoded secret.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/authentication/keys/totp-secret
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
OAuth 2.0 Authentication
Performs authentication using the OAuth 2.0 Authorization Framework.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
Grant type according to RFC 6749.


 Enum: "password" "refresh_token" "authorization_code" "public_key" "mfa" "as"  
username
string or null  [ 1 .. 2048 ] characters 
User name.




Used with the password grant type.




 
password
string or null <password>   [ 1 .. 128 ] characters 
Password.




Used with the password grant type.




 
refresh_token
string or null  [ 1 .. 2048 ] characters 
Refresh token.




Used with the refresh_token and as grant type.




 
mfa_token
string or null
Multi-factor authentication token.




Used with the mfa grant type.




 
mfa_code
string or null  <= 100 characters 
Multi-factor authentication code.




Used with the mfa grant type.




 
code
string or null
Authorization code.




Used with the authorization_code grant type.




 
public_key
string or null
Public key encoded in the Base64 format.




Used with the public_key grant type.




 
userUid
string or null <uuid> 
UID assigned to a user whose account must be used for authentication.




Used with the as grant type.




 
readOnly
boolean or null
Defines whether a read-only access token must be issued.




Used with any grant type.




 
Responses 
200
OK


400
Invalid data input.


post/token
Request samples 
application/x-www-form-urlencoded
grant_type=password&username=restv3vacadministrator&password=secretPassword&&&&&&&
Response samples 
application/json
{
  • "access_token": "Zm91cm5laWdoYm9ybWlnaHRwYXR0ZXJuY2hvb3NlaG93YXdhcmVjbHVieWVzdGVyZGF5ZXNwZWNpYWxseWZhbWlsaWFybGFyZ2VzdHNwb3J0b3RoZXJhY3R1YWx0aG91Z2hzb21ldGhpbmdzaW5nZ29vc2VqZXRqb2lueW91bmdkaWZmZXJlbmNlYnJpZ2h0aW5zdGVhZGFnYWlud2hhdGZpbmdlcndlc3Rlcm5leHBsYWluZmF0aGVycGhyYXNlY29tcGFueWRyaXZlbmFibGV3aGV0-GVyd2VsY29tZW5vZGRlZHNhdmVkbG9uZ2ltcG9zc2libGVjcmVhdHVyZWZhc3RlcmJyZWFrZmFzdGxhc3RiYXJlZm9sa3NhcHByb3ByaWF0ZW91Z2h0cm9wZW1hbm5vdHNpZ250aGlubGlzdGVubWlsbGxpc3RzbGlwcGVkZW5kYWdyZWVnZW50bHljaGFpbmNoZWVzZXRoaW5rZXhpc3Rrbm93bmJlZ2lubmluZ2Jyb2tlb3BlbnNwZWFrY2FsbGF2b2lkYnJhdmVwYXNzYWdlbGFkeXBlbmNpbGRhd250aGlua3BhcnR5d29tZW5tZXRodW5ncnlzaG9lcG93ZXJmdWxleHRyYWVuZ2luZWRyYXdjb3VudHJ5d291bGR0b3VjaHBocmFzZXdyaXRpbmdzaW1wbHl0b25ld29ybGRzdGF0ZW1lbnRzb2x1dGlvbnJlY29yZHJlcGVhdHJ1c2h0cnVua3Zhc3RzdH-1Y2t5ZWFycGllY2VmZWx0dW5jbGVpbnN0YW5jZWxhbmd1YWdlc29uZ2pvYmdyYWRlZHJpZWRnZW50bHljaGFydHRyb29wc2NvdmVyYXR0YWNoZWRidXJpZWRiYXNpc2F0dGVtcHRtYXliZXplcm9jbG9ja3NpdHRpbmd3aW5kc3VjY2Vzc2Z1bGNhcHRhaW5nZW5lcmFsbHlldmVyeXRoaW5nc2VlbW91dGhzcGVuZHByb2JhYg",
  • "token_type": "bearer",
  • "refresh_token": "cGx1c2VzdGFibGlzaGV2ZXJ5Ym9keWNvbHVtbmxhd2NvYWxtYWpvcnRvd25zaXhjYXJyaWVkc3RhbmRmaWZ0eWdyYWluY2lyY2xld2hvbXNwaXJpdHBsZWFzYW50ZHJpbmtwcmVzc3VyZWF2b2lkZmF2b3JpdGVsb2NhdGVzYWxlc2F0YmV0d2VlbmJvcm5mYWN0b3J5ZmVsdHNpbXBsZXdoZWVsd3JpdHRlbnByb3Blcmx5bGlzdGVuaG9zcGl0YWxncm91cHRvbW9ycm93c2xpZ2h0aG9sbG93c29saWRhbHRob3VnaHRhbGtzdG9waGl0dmlzaXR0aXRsZXJvYXJzcGVsbHNhdGVsbGl0ZXNyZWNvZ25pemVoaWRkZW5mb3J0eW1haWxjb21wYXJla2lsbHNvZnRwb3NpdGlvbnJlZ2lvbmJlYXR3aGVyZW1hbmFnZWR0aGlua2lsbGJ-aW5nY3V0c2xpcHRoZW9yeWFydGV4ZXJjaXNlc2h1dGRvbGxhcmJhbmRhY3R1YWxseW11ZGZ1bGx5cmVjYWxsZHJlc3NldmVudHVhbGx5b2JqZWN0cGFja2FnZWNodXJjaHN1cHBlcmRhcmtuZXNzcmVhZHdvcmVyYWJiaXRhY3R1YWxseXBvb3J0cmFkZXNoYWtlcHJpemVzZXR0bGVlbXB0eWhvbWVhc3Jlc2VhcmNocmVndWxhcnBvd2VyZnVsY29sZG1lc2lsa3Blb3BsZWxpbWl0ZWRhZHZlbnR1cmVjb21tdW5pdHlyaHltZXdpbmRvd2NvbWJpbmVj-3JyZWN0bHloYXJib3JjdXB3aW5kb3dmb3VydGhsaXZlZGVlcGx5aW5kdXN0cnl0aHJvd2ZvcndhcmRyaWNlaGF2aW5nb2NjYXNpb25hbGx5bm9yYW5jdXRzeXN0ZW1zeWxsYWJsZXN0cmF3d2F5bW90aGVybW9ybmluZ2NvbnZlcnNhdGlvbmJvdHRvbWV4cGVyaWVuY2VtZXRobw",
  • "mfa_token": null,
  • "encrypted_code": null,
  • "expires_in": 3600
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345