Tapes
API Key Scope: tapes / index
Numeric ID, serial, or name of tape library.
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
Filter on id
Filter on a pool id
Filter on barcode
Filter on location
Filter on type
Filter on locked
Filter on scratch
Filter on cleaning
Filter on write protect
Filter on mounted
Filter on ejected
Filter on known
Filter on mount count
Filter on date in
Filter on date move
Filter on free
Filter on max
Filter on last size update
Filter on last maintenance
Filter on last repack
Filter on repack status
Filter on force import type
Filter on need to check
List of tapes.
GET /api/v2/tape_libraries/{tape_library_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tapes.
{
"count": 1,
"tapes": [
{
"id": 10,
"tape_library_id": 2,
"pool_id": 6,
"barcode": "NOD407L5",
"location": "Slot 2",
"type": "data_lto5",
"locked": 1,
"scratch": 1,
"cleaning": 1,
"write_protect": [
"logical_locked"
],
"mounted": 1,
"ejected": 1,
"known": 1,
"mount_count": 1,
"date_in": "2025-11-05T16:01:42.362Z",
"date_move": "2025-11-05T16:01:42.362Z",
"free": 1,
"max": 1,
"last_size_update": "2025-11-05T16:01:42.362Z",
"last_maintenance": "2025-11-05T16:01:42.362Z",
"last_repack": "2025-11-05T16:01:42.362Z",
"repack_status": 1,
"force_import_type": 1,
"need_to_check": 1
}
]
}API Key Scope: tapes / index
Numeric ID, or name of pool.
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
Filter on id
Filter on tape library id
Filter on barcode
Filter on location
Filter on type
Filter on locked
Filter on scratch
Filter on cleaning
Filter on write protect
Filter on mounted
Filter on ejected
Filter on known
Filter on mount count
Filter on date in
Filter on date move
Filter on free
Filter on max
Filter on last size update
Filter on last maintenance
Filter on last repack
Filter on repack status
Filter on force import type
Filter on need to check
List of tapes.
GET /api/v2/pools/{pool_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tapes.
{
"count": 1,
"tapes": [
{
"id": 10,
"tape_library_id": 2,
"pool_id": 6,
"barcode": "NOD407L5",
"location": "Slot 2",
"type": "data_lto5",
"locked": 1,
"scratch": 1,
"cleaning": 1,
"write_protect": [
"logical_locked"
],
"mounted": 1,
"ejected": 1,
"known": 1,
"mount_count": 1,
"date_in": "2025-11-05T16:01:42.362Z",
"date_move": "2025-11-05T16:01:42.362Z",
"free": 1,
"max": 1,
"last_size_update": "2025-11-05T16:01:42.362Z",
"last_maintenance": "2025-11-05T16:01:42.362Z",
"last_repack": "2025-11-05T16:01:42.362Z",
"repack_status": 1,
"force_import_type": 1,
"need_to_check": 1
}
]
}API Key Scope: tapes / index
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
If set, only includes tapes that have/don't have any location.
Filter on id
Filter on tape library id
Filter on a pool id
Filter on barcode
Filter on location
Filter on type
Filter on locked
Filter on scratch
Filter on cleaning
Filter on write protect
Filter on mounted
Filter on ejected
Filter on known
Filter on mount count
Filter on date in
Filter on date move
Filter on free
Filter on max
Filter on last size update
Filter on last maintenance
Filter on last repack
Filter on repack status
Filter on force import type
Filter on need to check
List of tapes.
GET /api/v2/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tapes.
{
"count": 1,
"tapes": [
{
"id": 10,
"tape_library_id": 2,
"pool_id": 6,
"barcode": "NOD407L5",
"location": "Slot 2",
"type": "data_lto5",
"locked": 1,
"scratch": 1,
"cleaning": 1,
"write_protect": [
"logical_locked"
],
"mounted": 1,
"ejected": 1,
"known": 1,
"mount_count": 1,
"date_in": "2025-11-05T16:01:42.362Z",
"date_move": "2025-11-05T16:01:42.362Z",
"free": 1,
"max": 1,
"last_size_update": "2025-11-05T16:01:42.362Z",
"last_maintenance": "2025-11-05T16:01:42.362Z",
"last_repack": "2025-11-05T16:01:42.362Z",
"repack_status": 1,
"force_import_type": 1,
"need_to_check": 1
}
]
}API Key Scope: tapes / show
Numeric ID, or barcode of tape.
A specific tape.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tapes/{tape_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 10,
"tape_library_id": 2,
"pool_id": 6,
"barcode": "NOD407L5",
"location": "Slot 2",
"type": "data_lto5",
"locked": 1,
"scratch": 1,
"cleaning": 1,
"write_protect": [
"logical_locked"
],
"mounted": 1,
"ejected": 1,
"known": 1,
"mount_count": 1,
"date_in": "2025-11-05T16:01:42.362Z",
"date_move": "2025-11-05T16:01:42.362Z",
"free": 1,
"max": 1,
"last_size_update": "2025-11-05T16:01:42.362Z",
"last_maintenance": "2025-11-05T16:01:42.362Z",
"last_repack": "2025-11-05T16:01:42.362Z",
"repack_status": 1,
"force_import_type": 1,
"need_to_check": 1
}API Key Scope: tapes / destroy
Numeric ID, or barcode of tape.
Tape destroyed.
No content
DELETE /api/v2/tapes/{tape_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Tape destroyed.
No content
API Key Scope: tapes / mount_status
Numeric ID, or barcode of tape.
Mount status of storage.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tapes/{tape_id}/mount HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"mounted": true,
"message": "text",
"status": {
"id": 123,
"major_minor": "0:189",
"target": "/mnt/MOUNT_POINTS/folder",
"source": "//server.local/shared_folder",
"options": "vers=3.0,rsize=1048576,wsize=1048576",
"type": "cifs",
"pool_id": 1,
"pool_name": "text",
"nas_id": 1,
"nas_name": "text",
"nas_share_id": 1,
"nas_share_name": "text",
"cloud_connector_id": 1,
"cloud_connector_name": "text",
"cloud_bucket_id": 1,
"cloud_bucket_name": "text",
"tape_id": 1,
"tape_barcode": "text",
"tape_library_id": 1,
"tape_library_name": "text",
"tape_library_serial": "text"
}
}API Key Scope: tape_stats / show
Numeric ID, or barcode of tape.
A specific tape statistic.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tapes/{tape_id}/tape_stat HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"log_time": "text",
"barcode": "text",
"mounts": 1,
"datasets_written": 1,
"datasets_read": 1,
"recovered_write_data_errors": 1,
"unrecovered_write_data_errors": 1,
"write_servo_errors": 1,
"unrecovered_write_servo_errors": 1,
"recovered_read_errors": 1,
"unrecovered_read_errors": 1,
"last_mount_unrecovered_write_errors": 1,
"last_mount_unrecovered_read_errors": 1,
"last_mount_mbytes_written": 1,
"last_mount_mbytes_read": 1,
"lifetime_mbytes_written": 1,
"lifetime_mbytes_read": 1,
"last_load_write_compression_ratio": 1,
"last_load_read_compression_ratio": 1,
"medium_mount_time": 1,
"medium_ready_time": 1,
"total_native_capacity": 1,
"total_used_native_capacity": 1,
"write_protect": 1,
"worm": 1,
"beginning_of_medium_passes": 1,
"middle_of_tape_passes": 1,
"read_compression_ratio": 1,
"write_compression_ratio": 1,
"mbytes_transferred_to_app_client": 1,
"bytes_transferred_to_app_client": 1,
"mbytes_read_from_medium": 1,
"bytes_read_from_medium": 1,
"mbytes_transferred_from_app_client": 1,
"bytes_transferred_from_app_client": 1,
"mbytes_written_to_medium": 1,
"bytes_written_to_medium": 1,
"data_compression_enabled": 1,
"partition_0_remaining_capacity": 1,
"partition_1_remaining_capacity": 1,
"partition_0_maximum_capacity": 1,
"partition_1_maximum_capacity": 1
}API Key Scope: tape_stats / index
The number of items to display for pagination.
The number of items to skip for pagination.
List of tape statistics.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/tape_stats HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"count": 1,
"tape_stats": [
{
"log_time": "text",
"barcode": "text",
"mounts": 1,
"datasets_written": 1,
"datasets_read": 1,
"recovered_write_data_errors": 1,
"unrecovered_write_data_errors": 1,
"write_servo_errors": 1,
"unrecovered_write_servo_errors": 1,
"recovered_read_errors": 1,
"unrecovered_read_errors": 1,
"last_mount_unrecovered_write_errors": 1,
"last_mount_unrecovered_read_errors": 1,
"last_mount_mbytes_written": 1,
"last_mount_mbytes_read": 1,
"lifetime_mbytes_written": 1,
"lifetime_mbytes_read": 1,
"last_load_write_compression_ratio": 1,
"last_load_read_compression_ratio": 1,
"medium_mount_time": 1,
"medium_ready_time": 1,
"total_native_capacity": 1,
"total_used_native_capacity": 1,
"write_protect": 1,
"worm": 1,
"beginning_of_medium_passes": 1,
"middle_of_tape_passes": 1,
"read_compression_ratio": 1,
"write_compression_ratio": 1,
"mbytes_transferred_to_app_client": 1,
"bytes_transferred_to_app_client": 1,
"mbytes_read_from_medium": 1,
"bytes_read_from_medium": 1,
"mbytes_transferred_from_app_client": 1,
"bytes_transferred_from_app_client": 1,
"mbytes_written_to_medium": 1,
"bytes_written_to_medium": 1,
"data_compression_enabled": 1,
"partition_0_remaining_capacity": 1,
"partition_1_remaining_capacity": 1,
"partition_0_maximum_capacity": 1,
"partition_1_maximum_capacity": 1
}
]
}Last updated
Was this helpful?