The API allows you list and view Tapes.
Returns list of tapes filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
backup-destination | query | no | ||
direction | query | no | ||
filter | query | no | ||
initialized | query | boolean | no | |
nameLike | query | no | ||
orderBy | query | no | ||
page | query | no | ||
size | query | no | ||
states | query | "EJECTED" or "NOT_PRESENT" or "READY" | yes | |
tape-library | query | no | ||
tape-location | query | no | ||
tape-manager | query | no | ||
type | query | "CLEANING" or "REGULAR" | no |
media type | data type | description |
---|---|---|
application/json | array of TapeDetails (JSON) | list of tapes filtered by specified query parameters |
GET /tapes
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"serialNumber" : "...",
"usedSpace" : 12345,
"totalSpace" : 12345,
"initialized" : true,
"state" : "READY",
"tapeLibrary" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapePoolBackupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "CLEANING"
} ]
Batch delete tapes.
media type | data type | description |
---|---|---|
application/json | array of NameAndGuid (JSON) | specify tapes to delete |
POST /tapes/batch-delete
Content-Type: application/json
[ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
} ]
HTTP/1.1 201 Created
Change tape locations.
media type | data type | description |
---|---|---|
application/json | LocationRequest (JSON) | specify tape location details |
media type | data type | description |
---|---|---|
application/json | array of TapeDetails (JSON) | list of tapes where location has been changed |
PUT /tapes/location
Content-Type: application/json
Accept: application/json
{
"tapes" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"serialNumber" : "...",
"usedSpace" : 12345,
"totalSpace" : 12345,
"initialized" : true,
"state" : "READY",
"tapeLibrary" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapePoolBackupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "CLEANING"
} ]
name | type | description |
---|---|---|
guid | path |
DELETE /tapes/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single tape.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for tape (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | TapeDetails (JSON) | tape details |
GET /tapes/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"serialNumber" : "...",
"usedSpace" : 12345,
"totalSpace" : 12345,
"initialized" : true,
"state" : "READY",
"tapeLibrary" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapePoolBackupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "CLEANING"
}
Update a non present tape.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for tape (use by vProtect) |
media type | data type |
---|---|
application/json | TapeUpdateRequest (JSON) |
media type | data type | description |
---|---|---|
application/json | TapeDetails (JSON) | tape details |
PUT /tapes/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"serialNumber" : "...",
"usedSpace" : 12345,
"totalSpace" : 12345,
"initialized" : true,
"state" : "READY",
"tapeLibrary" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapePoolBackupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "REGULAR"
}
Initialize tape.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for tape (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | TapeInitializeRequest (JSON) | specify tape initialization details to update |
media type | data type | description |
---|---|---|
application/json | TapeDetails (JSON) | updated details for tape |
PUT /tapes/{guid}/initialize
Content-Type: application/json
Accept: application/json
{
"totalSpace" : 12345,
"serialNumber" : "...",
"type" : "CLEANING"
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"serialNumber" : "...",
"usedSpace" : 12345,
"totalSpace" : 12345,
"initialized" : true,
"state" : "READY",
"tapeLibrary" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapePoolBackupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"tapeLocation" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "CLEANING"
}
Get used space on a single tape.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for tape (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | number (JSON) | used space on a single tape |
GET /tapes/{guid}/used-space
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...