Secure Share - Share Links API Reference
Base URL
share.<csp>.<region>.pangea.cloud
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/buckets' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json'
Response
List buckets.
Get information on the accessible buckets.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
Delete an object.
Delete an item from the Secure Share by providing its id
. 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/v1/folder/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
Create a folder.
Create a Secure Share folder.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/get' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-get
Get metadata or download a file with from Secure Share by id
.
See Transfer Methods for information on transfer_method
.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/get_archive' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-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/v1/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-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/v1/put' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'
Response
v-1-put
Upload a file to Secure Share.
See Transfer Methods for information on transfer_method
.
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
v-1-update
Update information, such as tags or metadata, about an object by id
.
Status Codes
Status | Status Code | Description |
---|---|---|
ShareBadTransferMethod | 400 | A bad or unsupported transfer method was specified. |
ShareCantDeleteRoot | 400 | You cannot delete the root folder. |
ShareExternalBucketNotVerified | 400 | An external bucket cannot be used unless it has been verified. |
ShareFileMalicious | 400 | The file was malicious. |
ShareIDMismatch | 400 | An ID was supplied that didn't match the associated object. |
ShareImmutableError | 400 | Immutable {subject} ($-prefixed) cannot be modified or removed. |
ShareLoopDetected | 400 | A folder path naming loop was detected. |
ShareMissingPayload | 400 | An API request was submitted without a file paylod. Check the API documentation and try again. |
ShareNameMismatch | 400 | A name was supplied that didn't match the associated object. If updating an object ty path, the name is not required. |
ShareNoDefaultBucket | 400 | No bucket_id supplied and no default bucket. |
ShareNotEmpty | 400 | A folder is not empty. |
ShareParentIDDoesNotExist | 400 | The supplied parent ID does not exist. |
SharePathContainsNonFolder | 400 | The supplied path contains a non folder part: {subject} |
ShareTypeMismatch | 400 |