Veeam Service Provider Console 9.3
REST API Reference
Related documents

Configuration

This resource collection represents security certificate installed on Veeam Service Provider Console server.

Get All Certificates on Veeam Service Provider Console Server

Returns a collection resource representation of security cerificates on Veeam Service Provider Console server that are available for installation.

Request
query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

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.7
Responses
200

OK

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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.

get/configuration/certificates
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Certificate
Returns a Veeam Service Provider Console server security certificate.


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.7
Responses 
200
OK


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/certificates/console
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Install Certificate
Installs a Veeam Service Provider Console server security certificate.


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.7
Request Body schema: application/json
required
thumbprint
required
string
Certificate thumbprint in the Certificate Store.


 
Responses 
200
Installed certificate.


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


put/configuration/certificates/console
Request samples 
application/json
{
  • "thumbprint": "CE21F28155125879BB9C36BD2E15D5DC49F356A8"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Syslog Targets
Returns a list of configured remote syslog targets. When enabled, system events and audit log entries are forwarded to these servers.


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.7
Responses 
200
OK


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/syslogTargets
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Syslog Target
Adds a new remote syslog target. Events will be forwarded to this server when enabled.


Request 
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.7
Request Body schema: application/json
required
Syslog target configuration.


serverAddress
required
string
Host name or IP address of the remote syslog server.


 
port
integer
 Default:  514
Port number for the remote syslog server.


 
protocol
string
 Default:  "Udp"
Transport protocol for syslog messages.


 Enum: "Udp" "Tcp"  
enabled
boolean
 Default:  true
Whether events are forwarded to this syslog server.


 
Responses 
201
Created


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/configuration/syslogTargets
Request samples 
application/json
{
  • "serverAddress": "syslog01.tech.local",
  • "port": 514,
  • "protocol": "Udp",
  • "enabled": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Modify Syslog Target
Updates an existing syslog target configuration.


Request 
path Parameters
syslogTargetId
required
string <uuid> 
 
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.7
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


patch/configuration/syslogTargets/{syslogTargetId}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Syslog Target
Removes a syslog target. Events will no longer be forwarded to this server.


Request 
path Parameters
syslogTargetId
required
string <uuid> 
 
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.7
Responses 
200
OK


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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/configuration/syslogTargets/{syslogTargetId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}