Get All File to Tape Jobs Configured on Backup Server
You can get a collection resource representation of all file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
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 file to tape jobs configured on a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs |
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 |
---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Backup server UID |
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 BackupServerFileTapeJob schema.
Example
The following request returns a representation of all file to tape jobs configured on a Veeam Backup & Replication server with UID 21086fb9-d65e-4549-b956-967c38b28794.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/21086fb9-d65e-4549-b956-967c38b28794/jobs/fileTapeJobs
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "57ebd217-beee-479d-ab12-467d7315a569", "fullMediaPoolUid": "0c79912f-2101-4fb0-96a9-cb613bfba657", "incrementalMediaPoolUid": "0c7bc12f-2101-4fb0-96a9-cb643bfba657" }, { "instanceUid": "9cad4d17-d977-48b8-a220-503837a57aea", "fullMediaPoolUid": "41137fd4-cc5c-43a0-8156-43655363ee31", "incrementalMediaPoolUid": "41137fd4-cc5c-43a0-8156-4364c163ee31" } ] } |