Secure Share API Reference
Beta
Base URL
share.<csp>.<region>.pangea.cloud
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-delete
Delete an item from the Secure Share by providing its id
or path
.
Provide just id
OR just path
.
The force
parameter can be used to delete folders and their contents even if the folder is not empty.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/folder/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-folder-create
Create a Secure Share folder.
Use either parent_id
with name
to specify the folder to be created, or use path
only to specify the complete path to the folder to be created.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/get' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-get
Download a file with from Secure Share by id
OR path
.
You can use the path
parameter alone to specify the full path to the file,
OR you can use the id
of the file to be downloaded.
See Transfer Methods for information on transfer_method
.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/get_archive' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-get-archive
Download an archive (tar or zip) containing the items identified by the ids in the ids
array parameter.
See Transfer Methods for information on transfer_method
.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-list
List files matching the given filter parameter.
Use the order
parameter to specify “asc” for ascending, or “desc” for descending order of the results.
Use the order_by
parameter to specify which field the order parameter refers to.
Use the size
parameter to indicate the maximum number of results to include per call (for pagination of the results).
When paginating results, use the value of result.last
from the response to the previous call as the value for the input parameter last
.
result.count
from the response gives the total number of items matching the filter.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/put' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'
Response
v-1-beta-put
Upload a file with a given name to a given destination folder path in Secure Share.
You can use the path
parameter alone to specify the full path to the named file for upload,
OR you can use the parent_id
(destination folder path) and the name
(for the file name) parameters together.
See Transfer Methods for information on transfer_method
.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-beta-update
Update information, such as tags or metadata, about an object by id
OR bypath
.
You can use the path
parameter alone to specify the full path to the file,
OR you can use the id
of the file whose information is to be updated.
Was this article helpful?