Cloud_connectors

Lists all cloud connectors.

get

API Key Scope: cloud_connectors / index Optional API Key Explicit Scope: cloud_connectors / get_secret_key

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

urlstringOptional

Filter on url

url_proxystringOptional

Filter on url proxy

providerstringOptional

Filter on provider

regionstringOptional

Filter on region

access_keystringOptional

Filter on access key

Responses

200

List of cloud connectors.

application/json

get

/cloud_connectors

HTTPcURLJavaScriptPython

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

200

List of cloud connectors.

{
  "count": 1,
  "cloud_connectors": [
    {
      "id": 1,
      "name": "text",
      "url": "text",
      "url_proxy": "text",
      "provider": "generic_s3",
      "region": "text",
      "access_key": "text",
      "secret_key": "text",
      "options": "text"
    }
  ]
}

Creates a new cloud connector.

post

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

namestringOptional

urlstringOptional

url_proxystringOptional

providerstring · enumOptionalPossible values:

regionstringOptional

access_keystringOptional

secret_keystringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

201

A specific cloud connector.

application/json

422

The received resource was not correctly formatted.

application/json

post

/cloud_connectors

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

{
  "id": 1,
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

Check result of cloud connector test job.

get

API Key Scope: cloud_connectors / test

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

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/-/test

HTTPcURLJavaScriptPython

GET /api/v2/cloud_connectors/-/test?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"
    }
  ]
}

Test an unsaved cloud connector.

put

API Key Scope: cloud_connectors / test

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

namestringOptional

urlstringOptional

url_proxystringOptional

providerstring · enumOptionalPossible values:

regionstringOptional

access_keystringOptional

secret_keystringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

202

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

application/json

put

/cloud_connectors/-/test

HTTPcURLJavaScriptPython

PUT /api/v2/cloud_connectors/-/test HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

202

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

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

Displays a specific cloud connector.

get

API Key Scope: cloud_connectors / show Optional API Key Explicit Scope: cloud_connectors / get_secret_key

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

200

A specific cloud connector.

application/json

get

/cloud_connectors/{cloud_connector_id}

HTTPcURLJavaScriptPython

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

200

A specific cloud connector.

{
  "id": 1,
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

Updates a specific cloud connector.

put

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

Body

application/json

idinteger · int64Read-onlyOptional

namestringOptional

urlstringOptional

url_proxystringOptional

providerstring · enumOptionalPossible values:

regionstringOptional

access_keystringOptional

secret_keystringOptional

optionsstringOptional

S3FS mounting options, separated by comma

Responses

200

A specific cloud connector.

application/json

422

The received resource was not correctly formatted.

application/json

put

/cloud_connectors/{cloud_connector_id}

HTTPcURLJavaScriptPython

PUT /api/v2/cloud_connectors/{cloud_connector_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

{
  "id": 1,
  "name": "text",
  "url": "text",
  "url_proxy": "text",
  "provider": "generic_s3",
  "region": "text",
  "access_key": "text",
  "secret_key": "text",
  "options": "text"
}

Destroys a specific cloud connector.

delete

API Key Scope: cloud_connectors / destroy

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

204

Cloud connector destroyed.

delete

/cloud_connectors/{cloud_connector_id}

HTTPcURLJavaScriptPython

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

204

Cloud connector destroyed.

No content