HomepageBlog

Pools

Lists all pools.

get

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

commentstringOptional

Filter on comment

typestringOptional

Filter on type

contentstringOptional

Filter on content

Responses
200

List of pools.

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

List of pools.

{
  "count": 1,
  "pools": [
    {
      "id": 6,
      "name": "offline-tapes",
      "comment": "",
      "type": "offline_archive",
      "content": "tape",
      "storage_id": 2,
      "tape_write_protect_when_full": true
    }
  ]
}

Creates a new pool.

post

API Key Scope: pools / create

Authorizations
Body
all ofOptional
Responses
201

A specific pool.

application/json
post
/pools
POST /api/v2/pools HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "tape_ids": [
    10,
    11,
    12
  ],
  "nas_share_ids": [
    15
  ],
  "cloud_bucket_ids": [
    15
  ]
}
{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true
}

Displays a specific pool.

get

API Key Scope: pools / show

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Responses
200

A specific pool.

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

{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true
}

Updates a specific pool.

put

API Key Scope: pools / update

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Body
all ofOptional
Responses
200

A specific pool.

application/json
put
/pools/{pool_id}
PUT /api/v2/pools/{pool_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "tape_ids": [
    10,
    11,
    12
  ],
  "nas_share_ids": [
    15
  ],
  "cloud_bucket_ids": [
    15
  ]
}
{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true
}

Destroys a specific tape pool.

delete

API Key Scope: pools / destroy

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Responses
204

Pool destroyed.

No content
delete
/pools/{pool_id}
DELETE /api/v2/pools/{pool_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Pool destroyed.

No content

Displays the primary pool scan status.

get

API Key Scope: primary_scans / show

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Responses
200

The primary pool scan status.

application/json
get
/pools/{pool_id}/primary_scan
GET /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "pool_id": 16,
  "enabled": true,
  "operand": 4,
  "unit": "minutes"
}

Set a new primary pool scan option.

post

API Key Scope: primary_scans / create

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Body
idinteger · int64Read-onlyOptional
pool_idintegerOptionalExample: 16
enabledbooleanOptionalExample: true
operandnumberOptionalExample: 4
unitstring · enumOptionalPossible values:
Responses
201

The primary pool scan status.

application/json
post
/pools/{pool_id}/primary_scan
POST /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "pool_id": 16,
  "enabled": true,
  "operand": 4,
  "unit": "minutes"
}
{
  "id": 1,
  "pool_id": 16,
  "enabled": true,
  "operand": 4,
  "unit": "minutes"
}

Updates the existing primary pool scan option.

put

API Key Scope: primary_scans / update

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Body
idinteger · int64Read-onlyOptional
pool_idintegerOptionalExample: 16
enabledbooleanOptionalExample: true
operandnumberOptionalExample: 4
unitstring · enumOptionalPossible values:
Responses
200

The primary pool scan status.

application/json
put
/pools/{pool_id}/primary_scan
PUT /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "pool_id": 16,
  "enabled": true,
  "operand": 4,
  "unit": "minutes"
}
{
  "id": 1,
  "pool_id": 16,
  "enabled": true,
  "operand": 4,
  "unit": "minutes"
}

Disable the primary pool scan.

delete

API Key Scope: primary_scans / destroy

Authorizations
Path parameters
pool_idstringRequired

Numeric ID, or name of pool.

Responses
204

Primary pool scan disabled.

No content
delete
/pools/{pool_id}/primary_scan
DELETE /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Primary pool scan disabled.

No content

Last updated

Was this helpful?