Veeam Service Provider Console 9.1
REST API Reference
Related documents

Plugins

This resource collection represents plugins for Veeam Service Provider Console.

Get Plugin

Returns a resource representation of a currently installed plugin with the specified ID.

Request
path Parameters
pluginId
required
string <uuid>

ID assigned to a plugin.

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/plugins/{pluginId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Uninstall Plugin
Uninstalls a currently installed plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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/plugins/{pluginId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Assign API Key to Plugin
Assigns an API key to a plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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
apiKey
string or null
API key that must be assigned to a plugin.


 
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/plugins/{pluginId}/apikey
Request samples 
application/json
{
  • "apiKey": "310cfbbe3fc812741b4RdLdu2uKCqFGzv8YN3SbSF5UXwQ5Ny28h6UvG692J5s2iIvNlci7ssP5cjk1FMFVvmwL1IjWanUQVR2qqmjpHzXy1SpYmL6hUBMGPVW5xl370"
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Configure Plugin Access Permissions for Organizations
Assigns and limits permissions for organizations to access a plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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
allowOrganizationIds
Array of strings or null
Array of IDs assigned to organizations that are permitted to access plugin.


 
denyOrganizationIds
Array of strings or null
Array of IDs assigned to organizations that are not permitted to access plugin.


 
allowOrganizationsByDefault
boolean or null
Defines whether all other organizations are permitted to access plugin by default.




Provide the null value to keep the current settings.




 
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/plugins/{pluginId}/organizations
Request samples 
application/json
{
  • "allowOrganizationIds": [
    ],
  • "denyOrganizationIds": [
    ],
  • "allowOrganizationsByDefault": true
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Configure Plugin Access Permissions for Management Agents
Assigns and limits permissions for management agents to access a plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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
allowAgemtIds
Array of strings or null
Array of IDs assigned to management agents that are permitted to access plugin.


 
denyAgentIds
Array of strings or null
Array of IDs assigned to management agents that are not permitted to access plugin.


 
allowAgentsByDefault
boolean or null
Defines whether all other management agents are permitted to access plugin by default.




Provide the null value to keep the current settings.




 
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/plugins/{pluginId}/agents
Request samples 
application/json
{
  • "allowAgemtIds": [
    ],
  • "denyAgentIds": [
    ],
  • "allowAgentsByDefault": true
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Modify Plugin Status.
Modifies a status of a plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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
enabled
boolean
 Default:  true
Defines whether a plugin 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/plugins/{pluginId}/enabled
Request samples 
application/json
{
  • "enabled": true
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Plugin User Account Data
Returns a resource representation of information on plugin user account and server.




Should be used only by plugins.




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/plugins/user/islogged
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Installed Plugins
Returns a collection resource representation of all installed plugins.


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/plugins/
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Plugin Available Versions
Returns a collection resource representation of all available versions of a plugin with the specified ID.


Request 
path Parameters
pluginId
required
string <uuid> 
ID assigned to a plugin.


 
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/plugins/{pluginId}/versions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Charges for All Plugins
Returns a collection resource representation of charges for all registered plugins.


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/plugins/charges
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

    
    

                                

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