This is an archive version of the document. To get the most up-to-date information, see the current version.Get All File Share Copy Jobs
You can get a collection resource representation of all backup copy jobs for file shares.
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 collection resource representation of all backup copy jobs for file shares, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/fileShareCopyJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/fileShareCopyJobs |
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 BackupServerFileShareCopyJob schema.
Example 
The following request returns a representation of all file share copy jobs.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/fileShareCopyJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "732e9a7d-429e-46f3-9d87-97d703ae1814", "sourceFileShareJobUid": "407b308c-ef31-4cd6-bfe9-5051bb6f5f7f", "targetRepositoryUid": "88788f9e-d8f5-4eb4-bc4f-9b3f5103bcec", "retention": 28, "retentionUnit": "days" }, { "instanceUid": "35014f93-902d-4b46-9c60-7b18dede74a7", "sourceFileShareJobUid": "77255254-f96a-401e-b684-b338040a2d68", "targetRepositoryUid": "c0481b20-ce9d-4116-bf47-05cb46378b82", "retention": 28, "retentionUnit": "days" } ] } |