Cloud_connectors
API Key Scope: cloud_connectors / index Optional API Key Explicit Scope: cloud_connectors / get_secret_key
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 url
Filter on provider
Filter on region
Filter on access key
List of cloud connectors.
GET /api/v2/cloud_connectors HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of cloud connectors.
{
"count": 1,
"cloud_connectors": [
{
"id": 1,
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}
]
}API Key Scope: cloud_connectors / create
Pass the username and password of a user in the authorization header. This currently gives full access.
S3FS mounting options, separated by comma
A specific cloud connector.
The received resource was not correctly formatted.
POST /api/v2/cloud_connectors HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}{
"id": 1,
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}API Key Scope: cloud_connectors / test
Pass the username and password of a user in the authorization header. This currently gives full access.
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/-/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"
}
]
}API Key Scope: cloud_connectors / test
Pass the username and password of a user in the authorization header. This currently gives full access.
S3FS mounting options, separated by comma
An active job that may be queued, working, completed or failed.
PUT /api/v2/cloud_connectors/-/test HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: cloud_connectors / show Optional API Key Explicit Scope: cloud_connectors / get_secret_key
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of cloud connector.
A specific cloud connector.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/cloud_connectors/{cloud_connector_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": 1,
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}API Key Scope: cloud_connectors / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of cloud connector.
S3FS mounting options, separated by comma
A specific cloud connector.
The received resource was not correctly formatted.
PUT /api/v2/cloud_connectors/{cloud_connector_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}{
"id": 1,
"name": "text",
"url": "text",
"provider": "undefined",
"region": "text",
"access_key": "text",
"secret_key": "text",
"options": "text"
}API Key Scope: cloud_connectors / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Numeric ID or name of cloud connector.
Cloud connector destroyed.
DELETE /api/v2/cloud_connectors/{cloud_connector_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Cloud connector destroyed.
No content
Last updated
Was this helpful?