Tapes

(By tape library) Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

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

countintegerRead-onlyOptionalExample: 1

get

/tape_libraries/{tape_library_id}/tapes

HTTPcURLJavaScriptPython

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": "2026-02-19T15:09:08.028Z",
      "date_move": "2026-02-19T15:09:08.028Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2026-02-19T15:09:08.028Z",
      "last_maintenance": "2026-02-19T15:09:08.028Z",
      "last_repack": "2026-02-19T15:09:08.028Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

(By pool) Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

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

countintegerRead-onlyOptionalExample: 1

get

/pools/{pool_id}/tapes

HTTPcURLJavaScriptPython

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": "2026-02-19T15:09:08.028Z",
      "date_move": "2026-02-19T15:09:08.028Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2026-02-19T15:09:08.028Z",
      "last_maintenance": "2026-02-19T15:09:08.028Z",
      "last_repack": "2026-02-19T15:09:08.028Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

Lists all tapes.

get

API Key Scope: tapes / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

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

countintegerRead-onlyOptionalExample: 1

get

/tapes

HTTPcURLJavaScriptPython

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": "2026-02-19T15:09:08.028Z",
      "date_move": "2026-02-19T15:09:08.028Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2026-02-19T15:09:08.028Z",
      "last_maintenance": "2026-02-19T15:09:08.028Z",
      "last_repack": "2026-02-19T15:09:08.028Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

Displays a specific tape.

get

API Key Scope: tapes / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

200

A specific tape.

application/json

idinteger · int64Read-onlyOptionalExample: 10

tape_library_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

barcodestringRead-onlyOptionalExample: NOD407L5

locationstringRead-onlyOptionalExample: Slot 2

typestring · enumRead-onlyOptionalExample: data_lto5Possible values:

lockedintegerRead-onlyOptional

scratchintegerRead-onlyOptional

cleaningintegerRead-onlyOptional

mountedintegerRead-onlyOptional

ejectedintegerRead-onlyOptional

knownintegerRead-onlyOptional

mount_countintegerRead-onlyOptional

date_instring · date-timeRead-onlyOptional

date_movestring · date-timeRead-onlyOptional

freeinteger · int64Read-onlyOptional

maxinteger · int64Read-onlyOptional

last_size_updatestring · date-timeRead-onlyOptional

last_maintenancestring · date-timeRead-onlyOptional

last_repackstring · date-timeRead-onlyOptional

repack_statusintegerRead-onlyOptional

force_import_typeintegerRead-onlyOptional

need_to_checkintegerRead-onlyOptional

404

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

application/json

get

/tapes/{tape_id}

HTTPcURLJavaScriptPython

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": "2026-02-19T15:09:08.028Z",
  "date_move": "2026-02-19T15:09:08.028Z",
  "free": 1,
  "max": 1,
  "last_size_update": "2026-02-19T15:09:08.028Z",
  "last_maintenance": "2026-02-19T15:09:08.028Z",
  "last_repack": "2026-02-19T15:09:08.028Z",
  "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

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

204

Tape destroyed.

delete

/tapes/{tape_id}

HTTPcURLJavaScriptPython

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

204

Tape destroyed.

No content

Get mount status of Tape.

get

API Key Scope: tapes / mount_status

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

200

Mount status of storage.

application/json

mountedbooleanRead-onlyOptionalExample: true

messagestringRead-onlyOptional

404

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

application/json

get

/tapes/{tape_id}/mount

HTTPcURLJavaScriptPython

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"
  }
}

Display statistic for a specific tape.

get

API Key Scope: tape_stats / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

tape_idstringRequired

Numeric ID, or barcode of tape.

Responses

200

A specific tape statistic.

application/json

log_timestringRead-onlyOptional

barcodestringRead-onlyOptional

mountsintegerRead-onlyOptional

datasets_writtenintegerRead-onlyOptional

datasets_readintegerRead-onlyOptional

recovered_write_data_errorsintegerRead-onlyOptional

unrecovered_write_data_errorsintegerRead-onlyOptional

write_servo_errorsintegerRead-onlyOptional

unrecovered_write_servo_errorsintegerRead-onlyOptional

recovered_read_errorsintegerRead-onlyOptional

unrecovered_read_errorsintegerRead-onlyOptional

last_mount_unrecovered_write_errorsintegerRead-onlyOptional

last_mount_unrecovered_read_errorsintegerRead-onlyOptional

last_mount_mbytes_writtenintegerRead-onlyOptional

last_mount_mbytes_readintegerRead-onlyOptional

lifetime_mbytes_writtenintegerRead-onlyOptional

lifetime_mbytes_readintegerRead-onlyOptional

last_load_write_compression_ratiointegerRead-onlyOptional

last_load_read_compression_ratiointegerRead-onlyOptional

medium_mount_timeintegerRead-onlyOptional

medium_ready_timeintegerRead-onlyOptional

total_native_capacityintegerRead-onlyOptional

total_used_native_capacityintegerRead-onlyOptional

write_protectintegerRead-onlyOptional

wormintegerRead-onlyOptional

beginning_of_medium_passesintegerRead-onlyOptional

middle_of_tape_passesintegerRead-onlyOptional

read_compression_ratiointegerRead-onlyOptional

write_compression_ratiointegerRead-onlyOptional

mbytes_transferred_to_app_clientintegerRead-onlyOptional

bytes_transferred_to_app_clientintegerRead-onlyOptional

mbytes_read_from_mediumintegerRead-onlyOptional

bytes_read_from_mediumintegerRead-onlyOptional

mbytes_transferred_from_app_clientintegerRead-onlyOptional

bytes_transferred_from_app_clientintegerRead-onlyOptional

mbytes_written_to_mediumintegerRead-onlyOptional

bytes_written_to_mediumintegerRead-onlyOptional

data_compression_enabledintegerRead-onlyOptional

partition_0_remaining_capacityintegerRead-onlyOptional

partition_1_remaining_capacityintegerRead-onlyOptional

partition_0_maximum_capacityintegerRead-onlyOptional

partition_1_maximum_capacityintegerRead-onlyOptional

404

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

application/json

get

/tapes/{tape_id}/tape_stat

HTTPcURLJavaScriptPython

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

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

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

countintegerRead-onlyOptionalExample: 1

404

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

application/json

get

/tape_stats

HTTPcURLJavaScriptPython

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
    }
  ]
}