Cloud_buckets
API Key Scope: cloud_buckets / index
Numeric ID or name of cloud connector.
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 a pool id
Filter on name
Filter on location
Filter on price
List of cloud buckets.
GET /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of cloud buckets.
{
"count": 1,
"cloud_buckets": [
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}
]
}API Key Scope: cloud_buckets / sync
Numeric ID or name of cloud connector.
ID of active job
Simple list of cloud buckets.
An active job that may be queued, working, completed or failed.
GET /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"cloud_buckets": [
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}
]
}API Key Scope: cloud_buckets / sync
Numeric ID or name of cloud connector.
An active job that may be queued, working, completed or failed.
PUT /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync 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: cloud_buckets / show
Numeric ID or name of cloud connector.
Numeric ID or name of cloud bucket.
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / update
Numeric ID or name of cloud connector.
Numeric ID or name of cloud bucket.
S3FS mounting options, separated by comma
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
PUT /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"price": "text",
"options": "text"
}{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / index
Numeric ID, or name of pool.
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 cloud connector id
Filter on name
Filter on location
Filter on price
List of cloud buckets.
GET /api/v2/pools/{pool_id}/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of cloud buckets.
{
"count": 1,
"cloud_buckets": [
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}
]
}API Key Scope: cloud_buckets / show
Numeric ID, or name of pool.
Numeric ID or name of cloud bucket.
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/pools/{pool_id}/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / update
Numeric ID, or name of pool.
Numeric ID or name of cloud bucket.
S3FS mounting options, separated by comma
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
PUT /api/v2/pools/{pool_id}/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"price": "text",
"options": "text"
}{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / index
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 cloud connector id
Filter on a pool id
Filter on name
Filter on location
Filter on price
List of cloud buckets.
GET /api/v2/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of cloud buckets.
{
"count": 1,
"cloud_buckets": [
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}
]
}API Key Scope: cloud_buckets / create
S3FS mounting options, separated by comma
A specific cloud bucket.
The received resource was not correctly formatted.
POST /api/v2/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"price": "text",
"options": "text"
}{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / show
Numeric ID or name of cloud bucket.
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_buckets / update
Numeric ID or name of cloud bucket.
S3FS mounting options, separated by comma
A specific cloud bucket.
The requested resource was not found. The detailed error will be of type not_found.
PUT /api/v2/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"price": "text",
"options": "text"
}{
"id": 1,
"cloud_connector_id": 1,
"pool_id": 1,
"name": "text",
"file_count": 1,
"file_size_sum": 1,
"location": "text",
"price": "text",
"options": "text"
}API Key Scope: cloud_bucket / destroy
Numeric ID or name of cloud bucket.
cloud bucket destroyed.
No content
DELETE /api/v2/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
cloud bucket destroyed.
No content
API Key Scope: cloud_buckets / update_config_file
Numeric ID or name of cloud bucket.
Config file to upload.
S3 type for determining storage path.
Remote URI
The requested resource was not found. The detailed error will be of type not_found.
PUT /api/v2/cloud_buckets/{cloud_bucket_id}/config_file HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 46
{
"config_file": "binary",
"s3_type": "s3-native"
}textLast updated
Was this helpful?