Veeam Service Provider Console 9.1
REST API Reference
Related documents

Organizations

This resource collection represent organizations in Veeam Service Provider Console. Organizations include service provider, resellers and companies.

Get All Custom Settings of Email Notification

Returns a collection resource representation of all custom settings configured for email notifications.

Request
query Parameters
organizationUid
string or null <uuid>

Organization UID.

organizationType
string or null

Organization type.

Enum: "Unknown" "Company" "Reseller"
organizationScope
string or null

Scope of notified organizations.

Enum: "Unknown" "CurrentObject" "ChildObjects"
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/organizations/configuration/notification/welcomeEmails
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Custom Settings of Organization Email Notifications
Returns a resource representation of custom settings configured for email notifications of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
organizationType
required
string
Organization type.


 Enum: "Unknown" "Company" "Reseller"  
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/organizations/{organizationUid}/configuration/notification/welcomeEmail
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Configure Custom Settings for Organization Email Notifications
Configures custom settings for email notifications of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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
Email notification settings.


emailContent
string or null  [ 0 .. 10000 ] characters 
Content of an email message.


 
showSelfServiceSection
boolean
 Default:  true
Indicates whether the Self-service section is included in the email message.


 
isDefault
boolean
 Default:  true
Indicates whether an email message template is selected by default.


 
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/organizations/{organizationUid}/configuration/notification/welcomeEmail
Request samples 
application/json
{
  • "emailContent": "SP Company welcome template",
  • "showSelfServiceSection": true,
  • "isDefault": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Modify Custom Settings of Organization Email Notifications
Modifies custom settings configured for email notification of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
organizationType
required
string
Organization type.


 Enum: "Unknown" "Company" "Reseller"  
organizationScope
required
string
Scope of notified organizations.


 Enum: "Unknown" "CurrentObject" "ChildObjects"  
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/organizations/{organizationUid}/configuration/notification/welcomeEmail
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Organization Alarm Templates
Returns a resource representation of all alarm templates configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
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/organizations/{organizationUid}/configuration/alarms
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Enable Organization Alarm Templates
Enables all alarm templates configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/alarms/enable
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Disable Organization Alarm Templates
Disables all alarm templates configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/alarms/disable
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Organization Policy Settings
Returns a resource representation of policy settings configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/policy
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Policy Settings
Modifies policy settings configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/policy
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get Organization Notification Settings
Returns a resource representation of notification settings of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/notification
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Notification Settings
Modifies notification settings of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/notification
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Test SMTP Server Settings
Checks provided SMTP server settings. Returns updated and corrected settings and additional information on SMTP server.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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
SMTP settings.


serverAddress
required
string
SMTP server URI containing protocol, host and port.


 
timeout
required
string <time> 
Connection timeout.


 
tlsMode
required
string
Type of secure socket comminucation used to connect to an SMTP server.


 Enum: "auto" "none" "sslOnConnect" "startTls" "startTlsWhenAvailable"  
object or null
Credentials required to access an SMTP server.


 
object or null
Credentials for OAuth 2.0 authentication to an SMTP server.


 
exclusivelyAcceptedCertificateHash
string or null
Server X509 certificate hex-encoded hash in the <hash-algorithm>:<hash-hex> format.


 
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/organizations/{organizationUid}/configuration/notification/smtp/test
Request samples 
application/json
{
  • "serverAddress": "smtp://smtp1.tech.local:25",
  • "tlsMode": "auto",
  • "timeout": "2025-11-05T00:05:00.0000000+01:00",
  • "passwordCredential": null,
  • "oAuth2Credential": null,
  • "exclusivelyAcceptedCertificateHash": null
}
Response samples 
application/json
{
  • "data": {
    }
}
Test Email Notifications
Sends test email message with the specified settings.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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
Request Body schema: application/json
required
Test email settings.


from
required
string  [ 1 .. 1024 ] characters 
Email address from which test notification message is sent.


 
to
required
string  [ 1 .. 1024 ] characters 
Email address to which test notification message is sent.


 
senderName
string or null  [ 1 .. 1024 ] characters 
Name of a sender.


 
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/organizations/{organizationUid}/configuration/notification/test
Request samples 
application/json
{
  • "senderName": null,
  • "from": "notifications@mycompany.com",
  • "to": "admin@mycompany.com"
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Send SMTP Server OAuth 2.0 Authorization Request
Sends an OAuth 2.0 authorization request to access an SMTP server for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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
object
OAuth 2.0 client settings.


 
redirectUrl
required
string
Redirect URI. For details, see RFC6749.


 
state
string or null
 Default:  null
Request state returned to a client. For details, see RFC6749.


 
Responses 
200
Authentication parameters.


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/organizations/{organizationUid}/configuration/notification/oauth2/signin
Request samples 
application/json
{
  • "clientSettings": {
    },
  • "redirectUrl": "https://local.vspc.com:1280",
  • "state": null
}
Response samples 
Obtain SMTP Server OAuth 2.0 Authorization Tokens
Returns a pair of OAuth 2.0 authorization tokens to access an SMTP server for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
error
string
Error message.


 
error_description
string
Detailed error description.


 
code
string
Authorization code. For details, see RFC6749.


 
state
string
Request state returned to a client. For details, see RFC6749.


 
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
Authorization result.


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/organizations/{organizationUid}/configuration/notification/oauth2/signin/completion
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Organization Branding Settings
Returns a resource representation of branding settings of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/branding
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Branding Settings
Modifies branding settings of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/branding
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get Organization Portal URL
Returns a resource representation of a portal URL configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/loginUrl
Request samples 
Response samples 
application/json
{}
Replace Organization Portal URL
Replaces a portal configured for an organization with the specified UID.




Applies a portal URL to organizations that has no portal URL configured.
If the organization is a company and it has at least one configured IdP the operation will return an error with the 1000 code.
If the specified URL is already occupied by another organization the operation will return an error with the 10500 code.




Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
loginUrl
required
string  [ 1 .. 256 ] characters ^(http|https):\/\/[\w\d\-._~:/?#$&'()*+,;=]+$
Portal URL.


 
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.


put/organizations/{organizationUid}/configuration/loginUrl
Request samples 
Response samples 
application/json
{}
Get Organization Automatic Deployment Settings
Returns a resource representation of Veeam backup agent automatic deployment settings configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/autodeployment
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Automatic Deployment Settings
Modifies Veeam backup agent automatic deployment settings configured for an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/autodeployment
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Organizations
Returns a collection resource representation of all organizations (service provider, resellers, companies).


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/organizations
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Organization
Returns a resource representation of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization
Modifies an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Refresh Organization Security Token
Refreshes a security token issued to an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization 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/organizations/{organizationUid}/configuration/refreshsecuritytoken
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

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