Tape_libraries

Lists all tape libraries.

get

API Key Scope: tape_libraries / 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.

idstringOptional

Filter on id

namestringOptional

Filter on name

serialstringOptional

Filter on serial

commentstringOptional

Filter on comment

protocolstringOptional

Filter on protocol

vendorstringOptional

Filter on vendor

productstringOptional

Filter on product

firmwarestringOptional

Filter on firmware

devicestringOptional

Filter on device

libsostringOptional

Filter on libso

acsstringOptional

Filter on acs

statusstringOptional

Filter on status

storage_slotsstringOptional

Filter on storage slots

storage_slots_addressstringOptional

Filter on storage slots address

io_slotsstringOptional

Filter on io slots

io_slots_addressstringOptional

Filter on io slots address

pricestringOptional

Filter on price

Responses
200

List of tape libraries.

application/json
get
/tape_libraries
GET /api/v2/tape_libraries HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

List of tape libraries.

{
  "count": 1,
  "tape_libraries": [
    {
      "serial": "C0F905D800A0_LL3",
      "protocol": "scsi",
      "vendor": "IBM",
      "product": "3573-TL",
      "firmware": "6.24",
      "device": "/dev/sg9",
      "acs": 1,
      "storage_slots": 20,
      "storage_slots_address": 1024,
      "io_slots": 4,
      "io_slots_address": 768,
      "id": 2,
      "name": "my-library",
      "comment": "text",
      "libso": "ibm_3573-tl",
      "status": "online",
      "ready": true,
      "price": "5.0"
    }
  ]
}

Creates a new tape library.

post

API Key Scope: tape_libraries / create

Authorizations
Body
all ofOptional
Responses
201

A specific tape library.

application/json
Responseall of
post
/tape_libraries
POST /api/v2/tape_libraries HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "protocol": "scsi",
  "vendor": "IBM",
  "product": "3573-TL",
  "firmware": "6.24",
  "device": "/dev/sg9",
  "acs": 1,
  "storage_slots": 20,
  "storage_slots_address": 1024,
  "io_slots": 4,
  "io_slots_address": 768,
  "name": "my-library",
  "comment": "text",
  "libso": "ibm_3573-tl",
  "price": "5.0"
}
{
  "serial": "C0F905D800A0_LL3",
  "protocol": "scsi",
  "vendor": "IBM",
  "product": "3573-TL",
  "firmware": "6.24",
  "device": "/dev/sg9",
  "acs": 1,
  "storage_slots": 20,
  "storage_slots_address": 1024,
  "io_slots": 4,
  "io_slots_address": 768,
  "id": 2,
  "name": "my-library",
  "comment": "text",
  "libso": "ibm_3573-tl",
  "status": "online",
  "ready": true,
  "price": "5.0"
}

Lists tape libraries devices.

get

API Key Scope: tape_libraries / devices

Authorizations
Query parameters
job_idstringOptional

ID of active job

Responses
200

List of tape libraries devices.

application/json
Responseone of
or
get
/tape_libraries/-/devices
GET /api/v2/tape_libraries/-/devices HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
  "tape_libraries": [
    {
      "serial": "C0F905D800A0_LL3",
      "protocol": "scsi",
      "vendor": "IBM",
      "product": "3573-TL",
      "firmware": "6.24",
      "device": "/dev/sg9",
      "acs": 1,
      "storage_slots": 20,
      "storage_slots_address": 1024,
      "io_slots": 4,
      "io_slots_address": 768
    }
  ]
}

Displays a specific tape library.

get

API Key Scope: tape_libraries / show

Authorizations
Path parameters
tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Responses
200

A specific tape library.

application/json
Responseall of
get
/tape_libraries/{tape_library_id}
GET /api/v2/tape_libraries/{tape_library_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
  "serial": "C0F905D800A0_LL3",
  "protocol": "scsi",
  "vendor": "IBM",
  "product": "3573-TL",
  "firmware": "6.24",
  "device": "/dev/sg9",
  "acs": 1,
  "storage_slots": 20,
  "storage_slots_address": 1024,
  "io_slots": 4,
  "io_slots_address": 768,
  "id": 2,
  "name": "my-library",
  "comment": "text",
  "libso": "ibm_3573-tl",
  "status": "online",
  "ready": true,
  "price": "5.0"
}

Updates a specific tape library.

put

API Key Scope: tape_libraries / update

Authorizations
Path parameters
tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Body
all ofOptional
Responses
200

A specific tape library.

application/json
Responseall of
put
/tape_libraries/{tape_library_id}
PUT /api/v2/tape_libraries/{tape_library_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "protocol": "scsi",
  "vendor": "IBM",
  "product": "3573-TL",
  "firmware": "6.24",
  "device": "/dev/sg9",
  "acs": 1,
  "storage_slots": 20,
  "storage_slots_address": 1024,
  "io_slots": 4,
  "io_slots_address": 768,
  "name": "my-library",
  "comment": "text",
  "libso": "ibm_3573-tl",
  "price": "5.0"
}
{
  "serial": "C0F905D800A0_LL3",
  "protocol": "scsi",
  "vendor": "IBM",
  "product": "3573-TL",
  "firmware": "6.24",
  "device": "/dev/sg9",
  "acs": 1,
  "storage_slots": 20,
  "storage_slots_address": 1024,
  "io_slots": 4,
  "io_slots_address": 768,
  "id": 2,
  "name": "my-library",
  "comment": "text",
  "libso": "ibm_3573-tl",
  "status": "online",
  "ready": true,
  "price": "5.0"
}

Destroys a specific tape library.

delete

API Key Scope: tape_libraries / destroy

Authorizations
Path parameters
tape_library_idstringRequired

Numeric ID, serial, or name of tape library.

Responses
204

Tape library destroyed.

No content

delete
/tape_libraries/{tape_library_id}
DELETE /api/v2/tape_libraries/{tape_library_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Tape library destroyed.

No content

Last updated

Was this helpful?