This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Protected File Servers
You can get a collection resource representation of all protected file servers.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of all protected file servers, send the GET HTTP request to the URL of the /protectedWorkloads/fileServers/ collection.
HTTP Request
GET https://<hostname>:1280/api/v3/protectedWorkloads/fileServers |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the ProtectedFileServer schema.
Example 
The following request returns a representation of all protected file servers.
Request: GET https://localhost:1280/api/v3/protectedWorkloads/fileServers
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "fileServerUid": "bdc8f634-93ca-4a82-89f0-bade1a011c81", "backupServerUid": "ba2b2b14-9719-41e6-a36d-0d10db9513e0", "organizationUid": "244c672f-6882-49b3-a848-91b39649bb23", "jobUid": "0368020d-ad1d-4d06-b4f0-8ce5e6240ae1", "repositoryUid": "88788f9e-d8f5-4eb4-bc4f-9b3f5403b67c", "archiveRepositoryUid": "13421e56-89e8-468d-a0d8-d198f7a97b06", "name": "\\\\FILESERV05\\Documents", "archiveSize": 5472256, "shortTermBackupSize": 7996193, "archiveRestorePoints": 9, "restorePoints": 2, "latestRestorePointDate": "2020-03-30T06:00:43.0000000+00:00", "sourceSize": 7084544, "sources": [ { "path": "\\\\FILESERV05\\Documents", "inclusionMasks": [ "*.*" ], "exclusionMasks": [ "|.snapshot", " |~snapshot" ] } ] }, { "fileServerUid": "b22961d7-b2d8-4f7e-8a82-b7d3df7532d1", "backupServerUid": "0207e9d0-9819-4819-866d-7594a8f1a9dd", "organizationUid": "8a33b270-d812-4b2b-ab73-c6959b242a28", "jobUid": "0d51e785-0676-4b8f-ac1a-8dd43e477d84", "repositoryUid": "ac757f19-639c-415d-8f15-41c55e2762a9", "archiveRepositoryUid": null, "name": "FSS04:/NFS", "archiveSize": 0, "shortTermBackupSize": 18382848, "archiveRestorePoints": 0, "restorePoints": 96, "latestRestorePointDate": "2020-03-30T06:36:41.0000000+00:00", "sourceSize": 0, "sources": [ { "path": "FSS04:/NFS", "inclusionMasks": [ "*.*" ], "exclusionMasks": [] } ] } ] } |