Cloud_buckets

(By cloud connector) Lists all cloud buckets.

get

API Key Scope: cloud_buckets / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

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

pool_idstringOptional

Filter on a pool id

namestringOptional

Filter on name

locationstringOptional

Filter on location

pricestringOptional

Filter on price

Responses

200

List of cloud buckets.

application/json

get

/cloud_connectors/{cloud_connector_id}/cloud_buckets

HTTPcURLJavaScriptPython

GET /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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"
    }
  ]
}

Check result of cloud connector sync job.

get

API Key Scope: cloud_buckets / sync

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

Query parameters

job_idstringRequired

ID of active job

Responses

200

Simple list of cloud buckets.

application/json

202

An active job that may be queued, working, completed or failed.

application/json

get

/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Synchronize internal cloud buckets with their remote equivalent.

put

API Key Scope: cloud_buckets / sync

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

Responses

202

An active job that may be queued, working, completed or failed.

application/json

put

/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync

HTTPcURLJavaScriptPython

PUT /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

202

An active job that may be queued, working, completed or failed.

{
  "job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
  "status": "queued"
}

(By cloud connector) Displays a specific cloud bucket.

get

API Key Scope: cloud_buckets / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

get

/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

(By cloud connector) Updates a specific cloud bucket.

put

API Key Scope: cloud_buckets / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Body

application/json

idinteger · int64Read-onlyOptional

cloud_connector_idinteger · int64Read-onlyOptional

pool_idintegerRead-onlyOptional

namestringRead-onlyOptional

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

locationstringRead-onlyOptional

pricestringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

put

/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

(By cloud connector) Get mount status of Cloud bucket.

get

API Key Scope: cloud_buckets / mount_status

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_connector_idstringRequired

Numeric ID or name of cloud connector.

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

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

/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount

HTTPcURLJavaScriptPython

GET /api/v2/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_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"
  }
}

(By pool) Lists all cloud buckets from pool.

get

API Key Scope: cloud_buckets / index

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

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

cloud_connector_idstringOptional

Filter on cloud connector id

namestringOptional

Filter on name

locationstringOptional

Filter on location

pricestringOptional

Filter on price

Responses

200

List of cloud buckets.

application/json

get

/pools/{pool_id}/cloud_buckets

HTTPcURLJavaScriptPython

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

200

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"
    }
  ]
}

(By pool) Displays a specific cloud bucket.

get

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

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

get

/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

(By pool) Updates a specific cloud bucket.

put

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

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Body

application/json

idinteger · int64Read-onlyOptional

cloud_connector_idinteger · int64Read-onlyOptional

pool_idintegerRead-onlyOptional

namestringRead-onlyOptional

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

locationstringRead-onlyOptional

pricestringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

put

/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

(By pool) Get mount status of Cloud bucket.

get

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

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

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}/cloud_buckets/{cloud_bucket_id}/mount

HTTPcURLJavaScriptPython

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

Lists all cloud buckets.

get

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

cloud_connector_idstringOptional

Filter on cloud connector id

pool_idstringOptional

Filter on a pool id

namestringOptional

Filter on name

locationstringOptional

Filter on location

pricestringOptional

Filter on price

Responses

200

List of cloud buckets.

application/json

get

/cloud_buckets

HTTPcURLJavaScriptPython

GET /api/v2/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

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"
    }
  ]
}

Creates a new cloud bucket.

post

API Key Scope: cloud_buckets / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Body

application/json

idinteger · int64Read-onlyOptional

cloud_connector_idinteger · int64Read-onlyOptional

pool_idintegerRead-onlyOptional

namestringRead-onlyOptional

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

locationstringRead-onlyOptional

pricestringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

201

A specific cloud bucket.

application/json

422

The received resource was not correctly formatted.

application/json

post

/cloud_buckets

HTTPcURLJavaScriptPython

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

Displays a specific cloud bucket.

get

API Key Scope: cloud_buckets / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

get

/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

Updates a specific cloud bucket.

put

API Key Scope: cloud_buckets / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Body

application/json

idinteger · int64Read-onlyOptional

cloud_connector_idinteger · int64Read-onlyOptional

pool_idintegerRead-onlyOptional

namestringRead-onlyOptional

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

locationstringRead-onlyOptional

pricestringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

200

A specific cloud bucket.

application/json

404

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

application/json

put

/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

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

Destroys a specific cloud bucket.

delete

API Key Scope: cloud_bucket / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Responses

204

cloud bucket destroyed.

delete

/cloud_buckets/{cloud_bucket_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/cloud_buckets/{cloud_bucket_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

cloud bucket destroyed.

No content

Upload a config file for a specific cloud bucket.

put

API Key Scope: cloud_buckets / update_config_file

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

Body

multipart/form-data

config_filestring · binaryRequired

Config file to upload.

Responses

200

Remote URI

application/json

Responsestring

404

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

application/json

put

/cloud_buckets/{cloud_bucket_id}/config_file

HTTPcURLJavaScriptPython

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: 24

{
  "config_file": "binary"
}

text

Get mount status of Cloud bucket.

get

API Key Scope: cloud_buckets / mount_status

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

cloud_bucket_idstringRequired

Numeric ID or name of cloud bucket.

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

/cloud_buckets/{cloud_bucket_id}/mount

HTTPcURLJavaScriptPython

GET /api/v2/cloud_buckets/{cloud_bucket_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"
  }
}