Pools
API Key Scope: pools / index
Pass the username and password of a user in the authorization header. This currently gives full access.
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
Filter on id
Filter on name
Filter on comment
Filter on type
Filter on content
Filter on primary id
List of pools.
GET /api/v2/pools HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
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\" }}"
}
}
]
}API Key Scope: pools / create
Pass the username and password of a user in the authorization header. This currently gives full access.
A specific pool.
The received resource was not correctly formatted.
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\" }}"
}
}API Key Scope: pools / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
A specific pool.
GET /api/v2/pools/{pool_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
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\" }}"
}
}API Key Scope: pools / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
A specific pool.
The received resource was not correctly formatted.
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\" }}"
}
}API Key Scope: pools / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
Pool destroyed.
DELETE /api/v2/pools/{pool_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Pool destroyed.
No content
API Key Scope: primary_scans / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
The primary pool scan status.
GET /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
The primary pool scan status.
{
"id": 1,
"pool_id": 16,
"enabled": true,
"operand": 4,
"unit": "minutes"
}API Key Scope: primary_scans / create
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
16true4The primary pool scan status.
The received resource was not correctly formatted.
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"
}API Key Scope: primary_scans / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
16true4The primary pool scan status.
The received resource was not correctly formatted.
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"
}API Key Scope: primary_scans / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
Primary pool scan disabled.
DELETE /api/v2/pools/{pool_id}/primary_scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Primary pool scan disabled.
No content
API Key Scope: pools / sync_primary
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
New transaction number.
Synchronization triggered.
POST /api/v2/pools/{pool_id}/sync?tx=1 HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Synchronization triggered.
No content
API Key Scope: pools / mount_status
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
Mount status of storage.
The requested resource was not found. The detailed error will be of type not_found.
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"
}
}API Key Scope: pools / mount
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
Mount status of storage.
The requested resource was not found. The detailed error will be of type not_found.
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"
}
}API Key Scope: pools / unmount
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID, or name of pool.
Mount status of storage.
The requested resource was not found. The detailed error will be of type not_found.
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"
}
}Last updated
Was this helpful?