Secure Share API Reference

post/v1/share/link/create

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/share/link/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

POST

https://share.aws.us.pangea.cloud/v1/share/link/create

The link/create API takes an array of secure links objects and returns the result.share_link_object[] array containing a unique secured share link (result.share_link_objects[].link) for each of the elements in the links[].authenticators[] array .

links.targets[] is an array of object IDs for the file and/or folder objects that the link secures access to.

The links.link_type gives the type of link: download, upload, or editor. An upload type can only apply to a folder. Download and editor can apply to folders or files. Editor gives rename, delete, upload (put), and download (get) access to the objects listed in the links.targets[] array.

links[].expires_at gives the date and time that the secure link expires, and links[].max_access_count gives the maximum times a user can be authenticated to access a secure share link.

links[].authenticators[] is an array of authenticators objects, each of which contains an auth_type and an auth_context member. The links[].authenticators[].auth_type can be sms_otp, email_otp, or password, and the corresponding links[].authenticators[].auth_context must be the phone number (sms_otp), email address (email_otp), or password (password) to be used for securing the requested secure share link, which is returned in result.share_link_objects[].link.

links[].title and links[].message are optional parameters that can specify a title string and a message string to be used in notification emails and seen by the recipient when accessing shared content.

Response Schema

object

Pangea standard response schema

result

object

share_link_objects

array<object>

id

string

The ID of a share link.

minLength: 36

bucket_id

string

The ID of a share bucket resource.

minLength: 36
maxLength: 36

targets

array<string>

List of storage IDs

minItems: 1
maxItems: 1,000

link_type

string

Type of link

access_count

integer

The number of times a user has authenticated to access the share link.

max_access_count

integer

The maximum number of times a user can be authenticated to access the share link.

created_at

string (date-time)

The date and time the share link was created.

expires_at

string (date-time)

The date and time the share link expires.

last_accessed_at

string (date-time)

The date and time the share link was last accessed.

authenticators

array<object>

A list of authenticators

minItems: 1
maxItems: 10

auth_type

string

An authentication mechanism

auth_context

An email address

title

string

An optional title to use in accessing shares.

message

string

An optional message to use in accessing shares.

link

string

A URL to access the file/folders shared with a link.

recipient_email

string

An email address

sender_email

string

An email address

sender_name

string

The sender name information. Can be sender's full name for example.

tags

array<string>

A list of user-defined tags

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/share/link/get

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/share/link/get' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

POST

https://share.aws.us.pangea.cloud/v1/share/link/get

Get an existing secured share-link object by ID.

Response Schema

object

Pangea standard response schema

result

object

share_link_object

object

id

string

The ID of a share link.

minLength: 36

bucket_id

string

The ID of a share bucket resource.

minLength: 36
maxLength: 36

targets

array<string>

List of storage IDs

minItems: 1
maxItems: 1,000

link_type

string

Type of link

access_count

integer

The number of times a user has authenticated to access the share link.

max_access_count

integer

The maximum number of times a user can be authenticated to access the share link.

created_at

string (date-time)

The date and time the share link was created.

expires_at

string (date-time)

The date and time the share link expires.

last_accessed_at

string (date-time)

The date and time the share link was last accessed.

authenticators

array<object>

A list of authenticators

minItems: 1
maxItems: 10

auth_type

string

An authentication mechanism

auth_context

An email address

title

string

An optional title to use in accessing shares.

message

string

An optional message to use in accessing shares.

link

string

A URL to access the file/folders shared with a link.

recipient_email

string

An email address

sender_email

string

An email address

sender_name

string

The sender name information. Can be sender's full name for example.

tags

array<string>

A list of user-defined tags

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/share/link/list

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/share/link/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

POST

https://share.aws.us.pangea.cloud/v1/share/link/list

Return a list of existing secure share-links based on the given filter.

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.

bucket_id

string

The bucket to use, if not the default.

minLength: 36
maxLength: 36

filter

object

id

string

Only records where id equals this value.

id__contains

array<string>

Only records where id includes each substring.

id__in

array<string>

Only records where id equals one of the provided substrings.

target_id

string

Only records where target_id equals this value.

target_id__contains

array<string>

Only records where target_id includes each substring.

target_id__in

array<string>

Only records where target_id equals one of the provided substrings.

link_type

string

Only records where link_type equals this value.

link_type__contains

array<string>

Only records where link_type includes each substring.

link_type__in

array<string>

Only records where link_type equals one of the provided substrings.

access_count

integer

Only records where access_count equals this value.

access_count__gt

integer

Only records where access_count is greater than this value.

access_count__gte

integer

Only records where access_count is greater than or equal to this value.

access_count__lt

integer

Only records where access_count is less than this value.

access_count__lte

integer

Only records where access_count is less than or equal to this value.

max_access_count

integer

Only records where max_access_count equals this value.

max_access_count__gt

integer

Only records where max_access_count is greater than this value.

max_access_count__gte

integer

Only records where max_access_count is greater than or equal to this value.

max_access_count__lt

integer

Only records where max_access_count is less than this value.

max_access_count__lte

integer

Only records where max_access_count is less than or equal to this value.

created_at

string (date-time)

Only records where created_at equals this value.

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

expires_at

string (date-time)

Only records where expires_at equals this value.

expires_at__gt

string (date-time)

Only records where expires_at is greater than this value.

expires_at__gte

string (date-time)

Only records where expires_at is greater than or equal to this value.

expires_at__lt

string (date-time)

Only records where expires_at is less than this value.

expires_at__lte

string (date-time)

Only records where expires_at is less than or equal to this value.

last_accessed_at

string (date-time)

Only records where last_accessed_at equals this value.

last_accessed_at__gt

string (date-time)

Only records where last_accessed_at is greater than this value.

last_accessed_at__gte

string (date-time)

Only records where last_accessed_at is greater than or equal to this value.

last_accessed_at__lt

string (date-time)

Only records where last_accessed_at is less than this value.

last_accessed_at__lte

string (date-time)

Only records where last_accessed_at is less than or equal to this value.

link

string

Only records where link equals this value.

link__contains

array<string>

Only records where link includes each substring.

link__in

array<string>

Only records where link equals one of the provided substrings.

title

string

Only records where title equals this value.

title__contains

array<string>

Only records where title includes each substring.

title__in

array<string>

Only records where title equals one of the provided substrings.

message

string

Only records where message equals this value.

message__contains

array<string>

Only records where message includes each substring.

message__in

array<string>

Only records where message equals one of the provided substrings.

recipient_email

string

Only records where recipient_email equals this value.

recipient_email__contains

array<string>

Only records where recipient_email includes each substring.

recipient_email__in

array<string>

Only records where recipient_email equals one of the provided substrings.

sender_email

string

Only records where sender_email equals this value.

sender_email__contains

array<string>

Only records where sender_email includes each substring.

sender_email__in

array<string>

Only records where sender_email equals one of the provided substrings.

tags

array<string>

A list of tags that all must be present.

last

string

Reflected value from a previous response to obtain the next page of results.

order

string

Order results asc(ending) or desc(ending).

order_by

string

Which field to order results by.

size

integer

Maximum results to include in the response.

minimum: 1

Response Schema

object

Pangea standard response schema

result

object

count

integer

The total number of share links matched by the list request.

last

string

Used to fetch the next page of the current listing when provided in a repeated request's last parameter.

share_link_objects

array<object>

id

string

The ID of a share link.

minLength: 36

bucket_id

string

The ID of a share bucket resource.

minLength: 36
maxLength: 36

targets

array<string>

List of storage IDs

minItems: 1
maxItems: 1,000

link_type

string

Type of link

access_count

integer

The number of times a user has authenticated to access the share link.

max_access_count

integer

The maximum number of times a user can be authenticated to access the share link.

created_at

string (date-time)

The date and time the share link was created.

expires_at

string (date-time)

The date and time the share link expires.

last_accessed_at

string (date-time)

The date and time the share link was last accessed.

authenticators

array<object>

A list of authenticators

minItems: 1
maxItems: 10

auth_type

string

An authentication mechanism

auth_context

An email address

title

string

An optional title to use in accessing shares.

message

string

An optional message to use in accessing shares.

link

string

A URL to access the file/folders shared with a link.

recipient_email

string

An email address

sender_email

string

An email address

sender_name

string

The sender name information. Can be sender's full name for example.

tags

array<string>

A list of user-defined tags

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/share/link/delete

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/share/link/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

POST

https://share.aws.us.pangea.cloud/v1/share/link/delete

Delete a list of secured share-links by ID(s).

Response Schema

object

Pangea standard response schema

result

object

share_link_objects

array<object>

id

string

The ID of a share link.

minLength: 36

bucket_id

string

The ID of a share bucket resource.

minLength: 36
maxLength: 36

targets

array<string>

List of storage IDs

minItems: 1
maxItems: 1,000

link_type

string

Type of link

access_count

integer

The number of times a user has authenticated to access the share link.

max_access_count

integer

The maximum number of times a user can be authenticated to access the share link.

created_at

string (date-time)

The date and time the share link was created.

expires_at

string (date-time)

The date and time the share link expires.

last_accessed_at

string (date-time)

The date and time the share link was last accessed.

authenticators

array<object>

A list of authenticators

minItems: 1
maxItems: 10

auth_type

string

An authentication mechanism

auth_context

An email address

title

string

An optional title to use in accessing shares.

message

string

An optional message to use in accessing shares.

link

string

A URL to access the file/folders shared with a link.

recipient_email

string

An email address

sender_email

string

An email address

sender_name

string

The sender name information. Can be sender's full name for example.

tags

array<string>

A list of user-defined tags

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/share/link/send

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1/share/link/send' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

POST

https://share.aws.us.pangea.cloud/v1/share/link/send

Send a secure share-link notification to a set of email addresses.

The notification email will contain an Open button that the recipient can use to follow the secured share-link to authenticate and then access the shared content.

Response Schema

object

Pangea standard response schema

result

object

share_link_objects

array<object>

id

string

The ID of a share link.

minLength: 36

bucket_id

string

The ID of a share bucket resource.

minLength: 36
maxLength: 36

targets

array<string>

List of storage IDs

minItems: 1
maxItems: 1,000

link_type

string

Type of link

access_count

integer

The number of times a user has authenticated to access the share link.

max_access_count

integer

The maximum number of times a user can be authenticated to access the share link.

created_at

string (date-time)

The date and time the share link was created.

expires_at

string (date-time)

The date and time the share link expires.

last_accessed_at

string (date-time)

The date and time the share link was last accessed.

authenticators

array<object>

A list of authenticators

minItems: 1
maxItems: 10

auth_type

string

An authentication mechanism

auth_context

An email address

title

string

An optional title to use in accessing shares.

message

string

An optional message to use in accessing shares.

link

string

A URL to access the file/folders shared with a link.

recipient_email

string

An email address

sender_email

string

An email address

sender_name

string

The sender name information. Can be sender's full name for example.

tags

array<string>

A list of user-defined tags

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

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	You are trying to replace or update an object of one type (file, folder, etc.) to another. This is not allowed.
ShareUnableToScanBlocked	400	Configuration prevents unscannable files from being uploaded.
ShareUnsupportedHashes	400	One or more unsupported hashes were used: {subject}
ShareUpdatedAtMismatch	400	The supplied updated at timestamp didn't match the stored timestamp. Refresh your data and try again.
ShareVaultNotConfigured	400	An operation requiring vault was performed, but vault has not been configured.
ShareVaultPasswordDoesNotExist	400	No password exists on the associated object.
ShareVaultPasswordExists	400	A password already exists on the associated object.
ShareVaultPasswordMissing	400	An object is password protected and no password was provided.
ShareVaultPasswordNotAllowed	400	Encryption is not supported on an object, password not allowed.
ShareVaultPasswordWrong	400	An object is password protected and an invalid password was provided.
ShareVaultProblem	400	A vault problem was encountered. Check that your token has appropriate vault permissions.
ShareForbiddenFormat	403	The uploaded file format {subject} is not configured as an allowed format.
ShareForbiddenMedia	403	The uploaded file media type ({action}) and format ({subject}) is not allowed by configuration.
ShareSourceURLRejected	403	The provided source URL was rejected.
ShareTooLarge	403	The uploaded object exceeds the maximum configured size of {subject}.
SharePutObjectExists	409	An object with this Name already exists in this folder.
ShareTransferFailed	503	A temporary error occurred while handling an object.

Was this article helpful?

Contact us

Secure Share - Share Links API Reference

Base URL

Status Codes

Secure Share - Share Links API Reference

Base URL​

v-1-share-link-create

string

array<object>

array<string>

string

string (date-time)

integer

array<object>

string

Email Address

string

string

string

object

array<string>

string

object

object

array<object>

string

string

array<string>

string

integer

integer

string (date-time)

string (date-time)

string (date-time)

array<object>

string

Email Address

string

string

string

string

string

string

array<string>

string

string

string

string

string

v-1-share-link-get

string

string

object

object

object

string

string

array<string>

string

integer

integer

string (date-time)

string (date-time)

string (date-time)

array<object>

string

Email Address

string

string

string

string

string

string

array<string>

string

string

string

string

string

v-1-share-link-list

string

object

string

array<string>

Base URL