Pools

Lists all pools.

get

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

idstringOptional

Filter on id

namestringOptional

Filter on name

commentstringOptional

Filter on comment

typestringOptional

Filter on type

contentstringOptional

Filter on content

primary_idstringOptional

Filter on primary id

Responses

200

List of pools.

application/json

get

/pools

HTTPcURLJavaScriptPython

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",
      "primary_id": 100,
      "storage_id": 2,
      "tape_write_protect_when_full": true,
      "storage_extra_data": {
        "id": 1,
        "storage_id": 123,
        "storage_type": 1,
        "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
      }
    }
  ]
}

Creates a new pool.

post

API Key Scope: pools / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Body

application/json

Responses

201

A specific pool.

application/json

422

The received resource was not correctly formatted.

application/json

post

/pools

HTTPcURLJavaScriptPython

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

{
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "storage_extra_data": {
    "storage_id": 123,
    "storage_type": 1,
    "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
  },
  "tape_ids": [
    10,
    11,
    12
  ],
  "nas_share_ids": [
    15
  ],
  "cloud_bucket_ids": [
    15
  ]
}

{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "primary_id": 100,
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "storage_extra_data": {
    "id": 1,
    "storage_id": 123,
    "storage_type": 1,
    "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
  }
}

Displays a specific pool.

get

API Key Scope: pools / show

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.

Responses

200

A specific pool.

application/json

get

/pools/{pool_id}

HTTPcURLJavaScriptPython

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

200

A specific pool.

{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "primary_id": 100,
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "storage_extra_data": {
    "id": 1,
    "storage_id": 123,
    "storage_type": 1,
    "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
  }
}

Updates a specific pool.

put

API Key Scope: pools / update

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.

Body

application/json

Responses

200

A specific pool.

application/json

422

The received resource was not correctly formatted.

application/json

put

/pools/{pool_id}

HTTPcURLJavaScriptPython

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

{
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "storage_extra_data": {
    "storage_id": 123,
    "storage_type": 1,
    "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
  },
  "tape_ids": [
    10,
    11,
    12
  ],
  "nas_share_ids": [
    15
  ],
  "cloud_bucket_ids": [
    15
  ]
}

{
  "id": 6,
  "name": "offline-tapes",
  "comment": "",
  "type": "offline_archive",
  "content": "tape",
  "primary_id": 100,
  "storage_id": 2,
  "tape_write_protect_when_full": true,
  "storage_extra_data": {
    "id": 1,
    "storage_id": 123,
    "storage_type": 1,
    "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
  }
}

Destroys a specific tape pool.

delete

API Key Scope: pools / destroy

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.

Responses

204

Pool destroyed.

delete

/pools/{pool_id}

HTTPcURLJavaScriptPython

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

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.

Responses

200

The primary pool scan status.

application/json

get

/pools/{pool_id}/primary_scan

HTTPcURLJavaScriptPython

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

200

The primary pool scan status.

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

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.

Body

application/json

idinteger · int64Read-onlyOptional

pool_idintegerOptionalExample: 16

enabledbooleanOptionalExample: true

operandnumberOptionalExample: 4

unitstring · enumOptionalPossible values:

Responses

201

The primary pool scan status.

application/json

422

The received resource was not correctly formatted.

application/json

post

/pools/{pool_id}/primary_scan

HTTPcURLJavaScriptPython

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

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.

Body

application/json

idinteger · int64Read-onlyOptional

pool_idintegerOptionalExample: 16

enabledbooleanOptionalExample: true

operandnumberOptionalExample: 4

unitstring · enumOptionalPossible values:

Responses

200

The primary pool scan status.

application/json

422

The received resource was not correctly formatted.

application/json

put

/pools/{pool_id}/primary_scan

HTTPcURLJavaScriptPython

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

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.

Responses

204

Primary pool scan disabled.

delete

/pools/{pool_id}/primary_scan

HTTPcURLJavaScriptPython

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

Synchronize a primary after a scan (for internal use only).

post

API Key Scope: pools / sync_primary

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

txintegerRequired

New transaction number.

Responses

204

Synchronization triggered.

post

/pools/{pool_id}/sync

HTTPcURLJavaScriptPython

POST /api/v2/pools/{pool_id}/sync?tx=1 HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Synchronization triggered.

No content

Get mount status of Pool.

get

API Key Scope: pools / mount_status

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.

Responses

200

Mount status of storage.

application/json

404

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

application/json

get

/pools/{pool_id}/mount

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_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"
  }
}

Mount Pool.

put

API Key Scope: pools / mount

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.

Responses

200

Mount status of storage.

application/json

404

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

application/json

put

/pools/{pool_id}/mount

HTTPcURLJavaScriptPython

PUT /api/v2/pools/{pool_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"
  }
}

Unmount Pool.

delete

API Key Scope: pools / unmount

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.

Responses

200

Mount status of storage.

application/json

404

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

application/json

delete

/pools/{pool_id}/mount

HTTPcURLJavaScriptPython

DELETE /api/v2/pools/{pool_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"
  }
}