Tapes

(By tape library) Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

Path parameters

tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

pool_idstringOptional

Filter on a pool id

barcodestringOptional

Filter on barcode

locationstringOptional

Filter on location

typestringOptional

Filter on type

lockedstringOptional

Filter on locked

scratchstringOptional

Filter on scratch

cleaningstringOptional

Filter on cleaning

write_protectstringOptional

Filter on write protect

mountedstringOptional

Filter on mounted

ejectedstringOptional

Filter on ejected

knownstringOptional

Filter on known

mount_countstringOptional

Filter on mount count

date_instringOptional

Filter on date in

date_movestringOptional

Filter on date move

freestringOptional

Filter on free

maxstringOptional

Filter on max

last_size_updatestringOptional

Filter on last size update

last_maintenancestringOptional

Filter on last maintenance

last_repackstringOptional

Filter on last repack

repack_statusstringOptional

Filter on repack status

force_import_typestringOptional

Filter on force import type

need_to_checkstringOptional

Filter on need to check

Responses

200

List of tapes.

application/json

get

/tape_libraries/{tape_library_id}/tapes

GET /api/v2/tape_libraries/{tape_library_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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-05T15:52:34.540Z",
      "date_move": "2025-11-05T15:52:34.540Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:52:34.540Z",
      "last_maintenance": "2025-11-05T15:52:34.540Z",
      "last_repack": "2025-11-05T15:52:34.540Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

(By pool) Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

tape_library_idstringOptional

Filter on tape library id

barcodestringOptional

Filter on barcode

locationstringOptional

Filter on location

typestringOptional

Filter on type

lockedstringOptional

Filter on locked

scratchstringOptional

Filter on scratch

cleaningstringOptional

Filter on cleaning

write_protectstringOptional

Filter on write protect

mountedstringOptional

Filter on mounted

ejectedstringOptional

Filter on ejected

knownstringOptional

Filter on known

mount_countstringOptional

Filter on mount count

date_instringOptional

Filter on date in

date_movestringOptional

Filter on date move

freestringOptional

Filter on free

maxstringOptional

Filter on max

last_size_updatestringOptional

Filter on last size update

last_maintenancestringOptional

Filter on last maintenance

last_repackstringOptional

Filter on last repack

repack_statusstringOptional

Filter on repack status

force_import_typestringOptional

Filter on force import type

need_to_checkstringOptional

Filter on need to check

Responses

200

List of tapes.

application/json

get

/pools/{pool_id}/tapes

GET /api/v2/pools/{pool_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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-05T15:52:34.540Z",
      "date_move": "2025-11-05T15:52:34.540Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:52:34.540Z",
      "last_maintenance": "2025-11-05T15:52:34.540Z",
      "last_repack": "2025-11-05T15:52:34.540Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

has_locationsbooleanOptional

If set, only includes tapes that have/don't have any location.

idstringOptional

Filter on id

tape_library_idstringOptional

Filter on tape library id

pool_idstringOptional

Filter on a pool id

barcodestringOptional

Filter on barcode

locationstringOptional

Filter on location

typestringOptional

Filter on type

lockedstringOptional

Filter on locked

scratchstringOptional

Filter on scratch

cleaningstringOptional

Filter on cleaning

write_protectstringOptional

Filter on write protect

mountedstringOptional

Filter on mounted

ejectedstringOptional

Filter on ejected

knownstringOptional

Filter on known

mount_countstringOptional

Filter on mount count

date_instringOptional

Filter on date in

date_movestringOptional

Filter on date move

freestringOptional

Filter on free

maxstringOptional

Filter on max

last_size_updatestringOptional

Filter on last size update

last_maintenancestringOptional

Filter on last maintenance

last_repackstringOptional

Filter on last repack

repack_statusstringOptional

Filter on repack status

force_import_typestringOptional

Filter on force import type

need_to_checkstringOptional

Filter on need to check

Responses

200

List of tapes.

application/json

get

/tapes

GET /api/v2/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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-05T15:52:34.540Z",
      "date_move": "2025-11-05T15:52:34.540Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:52:34.540Z",
      "last_maintenance": "2025-11-05T15:52:34.540Z",
      "last_repack": "2025-11-05T15:52:34.540Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

Displays a specific tape.

get

API Key Scope: tapes / show

Authorizations

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

200

A specific tape.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/tapes/{tape_id}

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-05T15:52:34.540Z",
  "date_move": "2025-11-05T15:52:34.540Z",
  "free": 1,
  "max": 1,
  "last_size_update": "2025-11-05T15:52:34.540Z",
  "last_maintenance": "2025-11-05T15:52:34.540Z",
  "last_repack": "2025-11-05T15:52:34.540Z",
  "repack_status": 1,
  "force_import_type": 1,
  "need_to_check": 1
}

Destroys a specific tape. Only when it's an orphan.

delete

API Key Scope: tapes / destroy

Authorizations

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

204

Tape destroyed.

No content

delete

/tapes/{tape_id}

DELETE /api/v2/tapes/{tape_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Tape destroyed.

No content

Display statistic for a specific tape.

get

API Key Scope: tape_stats / show

Authorizations

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

200

A specific tape statistic.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/tapes/{tape_id}/tape_stat

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
}

List all tape statistics.

get

API Key Scope: tape_stats / index

Authorizations

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

Responses

200

List of tape statistics.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/tape_stats

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 1 day ago

Was this helpful?