Veeam Service Provider Console 9.1
REST API Reference
Related documents

Pulse

This resource collection represents VCSP Pulse integration support.

Get VCSP Pulse Configuration

Returns a resource representation of VCSP Pulse plugin configuration.

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

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

get/pulse
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify VCSP Pulse Configuration
Modifies VCSP Pulse plugin configuration.




To disconnect the plugin, replace the token property value with null.




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


patch/pulse
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Synchronize with VCSP Pulse Portal
Initiates synchronization with the VCSP Pulse portal.


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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


post/pulse/sync
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Rental Agreement Contracts
Returns a collection resource representation of all rental agreement contracts.


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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/pulse/contracts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Products Available in VCSP Pulse
Returns a collection resource representation of all Veeam products managed in VCSP Pulse.


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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/pulse/products
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Licenses Managed in VCSP Pulse
Rerurns a collection resource representation of all licenses managed in VCSP Pulse.


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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/pulse/licenses
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Add License to VCSP Pulse
Adds a new license configuration with the specified parameters to VCSP Pulse.


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
License parameters.


productId
required
string
ID asigned to a Veeam product that requires a license.


 
contractId
required
string
ID assigned to a rental agreement contract.


 
expirationDate
required
string <date-time> 
Date of the VCSP Pulse license expiration.


 
required
Array of objects (PulseLicenseWorkloadInput)   non-empty 
Array of workloads that must be licensed.


 
description
string or null
Description of a VCSP Pulse license.


 
isAutomaticReportingEnabled
boolean
 Default:  false
Defines whether automatic license reporting is enabled.


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


post/pulse/licenses
Request samples 
application/json
{
  • "productId": "VBR_PLS_12_0_0",
  • "contractId": "02553275",
  • "description": null,
  • "expirationDate": "2024-04-18T04:09:36.3594704+02:00",
  • "isAutomaticReportingEnabled": false,
  • "workloads": [
    ]
}
Response samples 
application/json
{
  • "data": {
    }
}
Get License Managed in VCSP Pulse
Rerurns a resource representation of a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


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


get/pulse/licenses/{licenseUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify License Managed in VCSP Pulse
Modifies a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


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


patch/pulse/licenses/{licenseUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete License Managed in VCSP Pulse.
Deletes a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


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


delete/pulse/licenses/{licenseUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Copy License Managed in VCSP Pulse
Creates a copy of a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


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


post/pulse/licenses/{licenseUid}/copy
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Revoke License Managed in VCSP Pulse
Revokes a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


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


post/pulse/licenses/{licenseUid}/revoke
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Install License Managed in VCSP Pulse
Installs a license managed in VCSP Pulse with the specified UID.




License must be issued to a company on whose server it will be installed. It also must not be installed on any other server.
Otherwise, the operation will create a copy of the license and install it on the server.




Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


 
query Parameters
serverUid
required
string <uuid> 
UID assigned to a server on which the license must be installed.


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


post/pulse/licenses/{licenseUid}/install
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Download License Managed in VCSP Pulse
Downloads a license managed in VCSP Pulse with the specified UID.


Request 
path Parameters
licenseUid
required
string <uuid> 
License UID.


 
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
License file 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/pulse/licenses/{licenseUid}/download
Request samples 
Response samples 
application/json
{
  • "data": "BAAKCAQBkzpzoQRvsrfsFWRUJxPUHFpwFrFePCIvrKbyOAw0nuiu0HOUgAuDUoktJRGArJDJ7uXIM6dnC8rcERUgpt/Zn0HcPkkOgRA2e5fTz5iYvia1YhI2p0MiLc1wKRmYM/li4rN/rTupdgucsE1eHJj9q1/hZ0kAfjsvCX6zt4Sq/SPeIom8lTAp5cfYuBX7efWI/EeAEs9BX/3JEPVyKplPji8nFPR8HTbxbNw+ntgMc8ymXYBeWrT7wa17eNcq7Ozzn+LzagGw+AP4Ky6DqlZTGWPPoV4f+Y0tznXMJXVTtI6BM33zK7T40ftiIjrPpvuOU3qFb2pTBHgymmlGtY03AgMBAAECggEALhgnuS+kZCn9wSlFrGzqGa6l8xYmB1pCGGrCNDGC/2pqd3ZK8sM+KRx4zmy8iJ2Jk/dtBiicET9InmRLpf/fZQL2niEkWRElJVAn0Yt4XEd+javlZiY/VU6aRLIWaPlDDItaxoPg5xD6KFCZX/I1prCJLBk9UUNnLo/p5qWAvWplfkbY4VpU7p67Cwgs37dBE87jjzqWZEQNc+aB87dz6hJfamBMZ/HKYdY3RwxA+XQCRfhl+qAgR26T/Y7PWEo5NH8kwBtkJ7U+IndNNjjTyW/med4HqNCYLINvSHRQkrs+rfUpY/+b5ObhA9UcdgIyRL1TryBDjpVqMNgn4ZvemQKBgQCtAL0/+EhUwDjKLbHM7JSZAYEhfgwfighB2kIf34YAoqT8t9i4aZX87Pj9GUKJVHiqvdeB32/QccmKkU8/g62DSe8KFDPWqK5r80LpC1JEsYifpcQ9dSmnuRGUGMBkMdDosLAkV8D3j5R03mcMhKXQ91f8NS5YQ5xQMwTBoo0oKwKBgQCVKy7PUEeTQuUGiZYg8UTG5xvRJudhai5UdITjwHijfp2MBjah6q7p0kjbqIM4LUo3AB8JnkKKvdVa9l8qKQhVYoKCX+gYBiGdfS9rAJvYyRhqwd5pvjpA3u+TcRbtJDbkotHCwhkzUEE5pBk3ebO5Yc6u5GK0u26boWx0onW9JQKBgArQrgQOwG7T6XjyLFhUPeHmzyzJ1XYvSd7cByA4+AaYJFpMH/c/WooKQnKIHrm5FyYNYiiTUEkmo+POu7aLw9AeUhw+MRNtTiIffgJVm9oBgzn/wenZpjX/AtNQTM62sompagmLltujFTPNJ4IH1NngbJauuGv6Jg55cgWs5MgrAoGBAIgUw/hWqWU7conbPH1C/VZjAWp1jkG9RxS+03ieXq/wUzOpe2+NFBK1Rsg027iFAJ5aWvZATT4a3ifEeJ6SnkqeuqbLbYV1Gnd8+6QnAwXqtn616/wVkTka5/5e/eZK0lUUAD4nKiw4u7gk7ug/+2hUROQh77YnA0mxIqrohnaNAoGAUdN3OYE0E95SPjrIuZGpJ/2zkruFjWT6Tie6EqZmxMgM+9ZlmfMIY5ED4jcewN7Q59v1zwDRrRMbUzUxzbqE7t7TgydFEESdUg4Q9iU9s90lopQnpcFThCrogigiTXmOhnqB5vkcYbtAZz/H1vRi3jN3YVgeXpw+X2tcEQ5SNck="
}
Get All VCSP Pulse Tenants
Returns a collection resource representation of all VCSP Pulse tenants.


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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/pulse/tenants
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create VCSP Pulse Tenant
Creates a VCSP Pulse tenant based on a specific company.


Request 
query Parameters
companyUid
required
string <uuid> 
Company UID.


 
rewriteExisting
boolean
Defines whether a company must be mapped to an existing tenant with the same name.


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


post/pulse/tenants
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get VCSP Pulse Tenant
Returns a resource representation of a VCSP Pulse tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string
VCSP Pulse tenant UID.


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


get/pulse/tenants/{tenantUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify VCSP Pulse Tenant
Modifies a VCSP Pulse tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string
VCSP Pulse tenant UID.


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


patch/pulse/tenants/{tenantUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Create Company from VCSP Tenant
Creates a company based on VCSP Pulse tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string
VCSP Pulse tenant UID.


 
query Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
gatewayPoolUid
string <uuid> 
Gateway pool UID.


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


post/pulse/tenants/{tenantUid}/createCompany
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

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