Containers
API Key Scope: containers / 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 quota total size
Filter on quota on cache
Filter on stat total files
Filter on stat total size
Filter on stat size on cache
Filter on guest right
Filter on last update
List of containers.
GET /api/v2/containers HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of containers.
{
"count": 1,
"containers": [
{
"id": 100,
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"stat_total_files": 99301,
"only_on_cache_file_count": 19123,
"stat_total_size": 6145076462,
"stat_size_on_cache": 6899417088,
"only_on_cache_file_size_sum": 3294517012,
"guest_right": "read",
"last_update": "2019-08-05T14:24:15.000Z"
}
]
}API Key Scope: containers / create
Pass the username and password of a user in the authorization header. This currently gives full access.
100my-containerRead only container for random stuff9930119123614507646268994170883294517012readPossible values: 2019-08-05T14:24:15.000ZA specific container.
The received resource was not correctly formatted.
POST /api/v2/containers HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"guest_right": "read"
}{
"id": 100,
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"stat_total_files": 99301,
"only_on_cache_file_count": 19123,
"stat_total_size": 6145076462,
"stat_size_on_cache": 6899417088,
"only_on_cache_file_size_sum": 3294517012,
"guest_right": "read",
"last_update": "2019-08-05T14:24:15.000Z"
}API Key Scope: containers / configure
Pass the username and password of a user in the authorization header. This currently gives full access.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/containers/-/configure?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: containers / configure
Pass the username and password of a user in the authorization header. This currently gives full access.
An active job that may be queued, working, completed or failed.
PUT /api/v2/containers/-/configure HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: containers / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
A specific container.
GET /api/v2/containers/{container_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific container.
{
"id": 100,
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"stat_total_files": 99301,
"only_on_cache_file_count": 19123,
"stat_total_size": 6145076462,
"stat_size_on_cache": 6899417088,
"only_on_cache_file_size_sum": 3294517012,
"guest_right": "read",
"last_update": "2019-08-05T14:24:15.000Z"
}API Key Scope: containers / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
100my-containerRead only container for random stuff9930119123614507646268994170883294517012readPossible values: 2019-08-05T14:24:15.000ZA specific container.
The received resource was not correctly formatted.
PUT /api/v2/containers/{container_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"guest_right": "read"
}{
"id": 100,
"name": "my-container",
"comment": "Read only container for random stuff",
"push_pool_id": 1,
"cleaning_pool_id": 1,
"quota_total_size": 1,
"quota_on_cache": 1,
"stat_total_files": 99301,
"only_on_cache_file_count": 19123,
"stat_total_size": 6145076462,
"stat_size_on_cache": 6899417088,
"only_on_cache_file_size_sum": 3294517012,
"guest_right": "read",
"last_update": "2019-08-05T14:24:15.000Z"
}API Key Scope: containers / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
Container destroyed.
DELETE /api/v2/containers/{container_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Container destroyed.
No content
API Key Scope: container_privileges / index
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
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 privilege
Filter on type
List of container privileges.
GET /api/v2/containers/{container_id}/container_privileges HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of container privileges.
{
"count": 1,
"container_privileges": [
{
"id": 1,
"name": "admin",
"privilege": "read_write",
"type": "user"
}
]
}API Key Scope: container_privileges / create
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
1adminread_writePossible values: userPossible values: A specific container privilege.
The received resource was not correctly formatted.
POST /api/v2/containers/{container_id}/container_privileges HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"name": "admin",
"privilege": "read_write",
"type": "user"
}{
"id": 1,
"name": "admin",
"privilege": "read_write",
"type": "user"
}API Key Scope: container_privileges / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
Numeric ID of container privilege.
A specific container privilege.
GET /api/v2/containers/{container_id}/container_privileges/{container_privilege_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific container privilege.
{
"id": 1,
"name": "admin",
"privilege": "read_write",
"type": "user"
}API Key Scope: container_privileges / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
Numeric ID of container privilege.
1adminread_writePossible values: userPossible values: A specific container privilege.
The received resource was not correctly formatted.
PUT /api/v2/containers/{container_id}/container_privileges/{container_privilege_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"name": "admin",
"privilege": "read_write",
"type": "user"
}{
"id": 1,
"name": "admin",
"privilege": "read_write",
"type": "user"
}API Key Scope: container_privileges / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of container.
Numeric ID of container privilege.
Container privilege destroyed.
DELETE /api/v2/containers/{container_id}/container_privileges/{container_privilege_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Container privilege destroyed.
No content
Last updated
Was this helpful?