Veeam Service Provider Console 9.3
REST API Reference
Related documents

Labels

Get All Labels

Returns a collection resource representation of all labels.

Request
query Parameters
scope
string (LabelScope)

Applies filtering by the label scope. Returns all labels whose scope includes the specified categories.

Enum: "VbrRepositories" "Agents"
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/labels
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Label
Creates a new label.


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
Label properties.


key
required
string  [ 1 .. 256 ] characters 
Label key. Must be unique across all labels.


 
scope
required
Array of strings (LabelScope)   non-empty  unique 
Array of categories to which a label may be assigned.


Items Enum: "VbrRepositories" "Agents"  
description
string or null  <= 2048 characters 
Description of a label.


 
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/labels
Request samples 
application/json
{
  • "key": "Production",
  • "description": "Repositories and agents serving production workloads.",
  • "scope": [
    ]
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Label
Returns a resource representation of a label with the specified UID.


Request 
path Parameters
labelUid
required
string <uuid> 
Label 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.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/labels/{labelUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Patch Label
Modifies a label with the specified UID.


Request 
path Parameters
labelUid
required
string <uuid> 
Label 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.7
Request Body schema: application/json
required
JSON Patch operations.


 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/labels/{labelUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Label
Deletes a label with the specified UID. All assignments using this label are also removed.


Request 
path Parameters
labelUid
required
string <uuid> 
Label 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.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/labels/{labelUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Label Assignments
Returns a collection of objects to which a label with the specified UID is assigned.


Request 
path Parameters
labelUid
required
string <uuid> 
Label 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.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/labels/{labelUid}/assignments
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}