Secure Share - General API Reference

Beta

Base URL

share.<csp>.<region>.pangea.cloud

• Secure Share Documentation
• OpenAPI Specification

post/v1beta/buckets

cURL

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/buckets' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json'

Response

Raw Output

200

Code Snippet Language

v-1-beta-buckets

POST

https://share.aws.us.pangea.cloud/v1beta/buckets

Get information on the accessible buckets.

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

A response to a buckets call.

A response to a buckets call.

buckets

array<object>

A list of available buckets.

A list of available buckets.

id

string

The ID of a share bucket resource.

• minLength: 36

• maxLength: 36

The ID of a share bucket resource.

• minLength: 36

• maxLength: 36

default

boolean

If true, is the default bucket.

If true, is the default bucket.

name

string

The bucket's friendly name.

The bucket's friendly name.

transfer_methods

array<string>

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"

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"

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"

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"

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.

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/v1beta/delete

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-delete

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

id

string

The ID of the object to delete.

• minLength: 36

​

The ID of the object to delete.

• minLength: 36

force

boolean

If true, delete a folder even if it's not empty. Deletes the contents of folder as well.

force

​

force

If true, delete a folder even if it's not empty. Deletes the contents of folder as well.

path

string

The path of the object to delete.

• minLength: 1

• maxLength: 256

​

The path of the object to delete.

• minLength: 1

• maxLength: 256

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

count

integer

Number of objects deleted.

Number of objects deleted.

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"

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"

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"

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"

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.

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/v1beta/folder/create

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-folder-create

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

name

string

The name of an object.

name

name

The name of an object.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Click 'Save' to use the value

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

parent_id

string

The ID of a stored object.

• minLength: 36

​

The ID of a stored object.

• minLength: 36

path

string

An case-sensitive path to an object. Contains a sequence of path segments delimited by the the / character. Any path ending in a / character refers to a folder.

• minLength: 1

• maxLength: 256

​

An case-sensitive path to an object. Contains a sequence of path segments delimited by the the / character. Any path ending in a / character refers to a folder.

• minLength: 1

• maxLength: 256

tags

array<string>

A list of user-defined tags

Click 'Save' to use the value

A list of user-defined tags

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Information on the created folder.

Information on the created folder.

object

object

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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/v1beta/get

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-get

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

id

string

The ID of the object to retrieve.

• minLength: 36

​

The ID of the object to retrieve.

• minLength: 36

path

string

The path of the object to retrieve.

• minLength: 1

• maxLength: 256

​

The path of the object to retrieve.

• minLength: 1

• maxLength: 256

password

string

If the file was protected with a password, the password to decrypt with.

password

password

If the file was protected with a password, the password to decrypt with.

transfer_method

string

The requested transfer method for the file data.

transfer_method

​

transfer_method

The requested transfer method for the file data.

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

File information.

File information.

dest_url

string

A URL where the file can be downloaded from. (transfer_method: dest-url)

A URL where the file can be downloaded from. (transfer_method: dest-url)

object

object

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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/v1beta/get_archive

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-get-archive

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

ids

array<string>

The IDs of the objects to include in the archive. Folders include all children.

Click 'Save' to use the value

The IDs of the objects to include in the archive. Folders include all children.

format

string

The format to use to build the archive.

format

​

format

The format to use to build the archive.

transfer_method

string

The requested transfer method for the file data.

transfer_method

​

transfer_method

The requested transfer method for the file data.

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

A response to a get_archive call.

A response to a get_archive call.

count

integer

Number of objects included in the archive.

Number of objects included in the archive.

dest_url

string

A location where the archive can be downloaded from. (transfer_method: dest-url)

A location where the archive can be downloaded from. (transfer_method: dest-url)

objects

array<object>

A list of all objects included in the archive.

A list of all objects included in the archive.

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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/v1beta/list

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-list

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

filter

object

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at

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__gt

created_at__gt

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__gte

created_at__gte

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__lt

created_at__lt

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.

created_at__lte

created_at__lte

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

folder

string

Only records where the object exists in the supplied parent folder path name.

​

Only records where the object exists in the supplied parent folder path name.

id

string

Only records where id equals this value.

id

id

Only records where id equals this value.

id__in

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

Only records where id equals one of the provided substrings.

name

string

Only records where name equals this value.

name

name

Only records where name equals this value.

name__contains

array<string>

Only records where name includes each substring.

Click 'Save' to use the value

Only records where name includes each substring.

name__in

array<string>

Only records where name equals one of the provided substrings.

Click 'Save' to use the value

Only records where name equals one of the provided substrings.

parent_id

string

Only records where parent_id equals this value.

parent_id

parent_id

Only records where parent_id equals this value.

parent_id__in

array<string>

Only records where parent_id equals one of the provided substrings.

Click 'Save' to use the value

Only records where parent_id equals one of the provided substrings.

size

integer

Only records where size equals this value.

size

size

Only records where size equals this value.

size__gt

integer

Only records where size is greater than this value.

size__gt

size__gt

Only records where size is greater than this value.

size__gte

integer

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

size__gte

size__gte

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

size__lt

integer

Only records where size is less than to this value.

size__lt

size__lt

Only records where size is less than to this value.

size__lte

integer

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

size__lte

size__lte

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

tags

array<string>

A list of tags that all must be present.

Click 'Save' to use the value

A list of tags that all must be present.

type

string

Only records where type equals this value.

type

type

Only records where type equals this value.

type__contains

array<string>

Only records where type includes each substring.

Click 'Save' to use the value

Only records where type includes each substring.

type__in

array<string>

Only records where type equals one of the provided substrings.

Click 'Save' to use the value

Only records where type equals one of the provided substrings.

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at

Only records where updated_at equals this value.

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gt

Only records where updated_at is greater than this value.

updated_at__gte

string (date-time)

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

updated_at__gte

updated_at__gte

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

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lt

Only records where updated_at is less than this value.

updated_at__lte

string (date-time)

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

updated_at__lte

updated_at__lte

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

include_external_bucket_key

boolean

If true, include the external_bucket_key in results.

include_external_bucket_key

​

include_external_bucket_key

If true, include the external_bucket_key in results.

last

string

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

last

last

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

order

string

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

order

​

order

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

order_by

string

Which field to order results by.

order_by

​

order_by

Which field to order results by.

size

integer

Maximum results to include in the response.

• minimum: 1

size

size

Maximum results to include in the response.

• minimum: 1

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

count

integer

The total number of objects matched by the list request.

The total number of objects 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.

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

objects

array<object>

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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/v1beta/put

cURL

curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/put' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'

Response

Raw Output

200

Code Snippet Language

v-1-beta-put

POST

https://share.aws.us.pangea.cloud/v1beta/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.

Content Type

multipart/form-data

Content Type

required parameters

request

object

upload

​

optional parameters

request

object

transfer_method

string

The transfer method used to upload the file data.

transfer_method

​

transfer_method

The transfer method used to upload the file data.

size

integer

The size (in bytes) of the file. If the upload doesn't match, the call will fail.

size

size

The size (in bytes) of the file. If the upload doesn't match, the call will fail.

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

crc32c

string

The hexadecimal-encoded CRC32C hash of the file data, which will be verified by the server if provided.

crc32c

crc32c

The hexadecimal-encoded CRC32C hash of the file data, which will be verified by the server if provided.

sha256

string

The SHA256 hash of the file data, which will be verified by the server if provided.

sha256

sha256

The SHA256 hash of the file data, which will be verified by the server if provided.

md5

string

The hexadecimal-encoded MD5 hash of the file data, which will be verified by the server if provided.

md5

md5

The hexadecimal-encoded MD5 hash of the file data, which will be verified by the server if provided.

name

string

The name of the object to store.

name

name

The name of the object to store.

format

string

The format of the file, which will be verified by the server if provided. Uploads not matching the supplied format will be rejected.

format

​

format

The format of the file, which will be verified by the server if provided. Uploads not matching the supplied format will be rejected.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Click 'Save' to use the value

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

mimetype

string

The MIME type of the file, which will be verified by the server if provided. Uploads not matching the supplied MIME type will be rejected.

​

The MIME type of the file, which will be verified by the server if provided. Uploads not matching the supplied MIME type will be rejected.

parent_id

string

The parent ID of the object (a folder). Leave blank to keep in the root folder.

• minLength: 36

​

The parent ID of the object (a folder). Leave blank to keep in the root folder.

• minLength: 36

path

string

An optional path where the file should be placed. It will auto-create directories if necessary.

• minLength: 1

• maxLength: 256

​

An optional path where the file should be placed. It will auto-create directories if necessary.

• minLength: 1

• maxLength: 256

password

string

An optional password to protect the file with. Downloading the file will require this password.

password

password

An optional password to protect the file with. Downloading the file will require this password.

password_algorithm

string

An optional password algorithm to protect the file with. See symmetric vault password_algorithm.

password_algorithm

​

password_algorithm

An optional password algorithm to protect the file with. See symmetric vault password_algorithm.

sha1

string

The hexadecimal-encoded SHA1 hash of the file data, which will be verified by the server if provided.

sha1

sha1

The hexadecimal-encoded SHA1 hash of the file data, which will be verified by the server if provided.

sha512

string

The hexadecimal-encoded SHA512 hash of the file data, which will be verified by the server if provided.

sha512

sha512

The hexadecimal-encoded SHA512 hash of the file data, which will be verified by the server if provided.

source_url

string

The URL to fetch the file payload from (for transfer_method source-url).

source_url

source_url

The URL to fetch the file payload from (for transfer_method source-url).

tags

array<string>

A list of user-defined tags

Click 'Save' to use the value

A list of user-defined tags

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

object

object

The object that was created.

The object that was created.

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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/v1beta/update

cURL

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

Response

Raw Output

200

Code Snippet Language

v-1-beta-update

POST

https://share.aws.us.pangea.cloud/v1beta/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.

fields

id

string

An identifier for the file to update.

• minLength: 36

​

An identifier for the file to update.

• minLength: 36

path

string

An alternative to ID for identifying the target file.

• minLength: 1

• maxLength: 256

​

An alternative to ID for identifying the target file.

• minLength: 1

• maxLength: 256

bucket_id

string

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

​

The bucket to use, if not the default.

• minLength: 36

• maxLength: 36

add_metadata

object

A list of Metadata key/values to set in the object. If a provided key exists, the value will be replaced.

• maxProperties: 256

Click 'Save' to use the value

A list of Metadata key/values to set in the object. If a provided key exists, the value will be replaced.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

add_password

string

Protect the file with the supplied password.

add_password

add_password

Protect the file with the supplied password.

add_password_algorithm

string

The algorithm to use to password protect the file.

add_password_algorithm

​

add_password_algorithm

The algorithm to use to password protect the file.

add_tags

array<string>

A list of Tags to add. It is not an error to provide a tag which already exists.

Click 'Save' to use the value

A list of Tags to add. It is not an error to provide a tag which already exists.

name

string

Sets the object's Name.

name

name

Sets the object's Name.

metadata

object

Set the object's metadata.

• maxProperties: 256

Click 'Save' to use the value

Set the object's metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

remove_metadata

object

A list of metadata key/values to remove in the object. It is not an error for a provided key to not exist. If a provided key exists but doesn't match the provided value, it will not be removed.

• maxProperties: 256

Click 'Save' to use the value

A list of metadata key/values to remove in the object. It is not an error for a provided key to not exist. If a provided key exists but doesn't match the provided value, it will not be removed.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

remove_password

string

Remove the supplied password from the file.

remove_password

remove_password

Remove the supplied password from the file.

remove_tags

array<string>

A list of tags to remove. It is not an error to provide a tag which is not present.

Click 'Save' to use the value

A list of tags to remove. It is not an error to provide a tag which is not present.

parent_id

string

Set the parent (folder) of the object. Can be an empty string for the root folder.

​

Set the parent (folder) of the object. Can be an empty string for the root folder.

tags

array<string>

Set the object's tags.

Click 'Save' to use the value

Set the object's tags.

updated_at

string (date-time)

The date and time the object was last updated. If included, the update will fail if this doesn't match the date and time of the last update for the object.

​

The date and time the object was last updated. If included, the update will fail if this doesn't match the date and time of the last update for the object.

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

object

object

billable_size

integer

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

The number of billable bytes (includes Metadata, Tags, etc.) for the object.

created_at

string (date-time)

The date and time the object was created.

The date and time the object was created.

expires_at

string (date-time)

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

The date and time the object TTL will expire and the object will be deleted, if the file has a TTL.

external_bucket_key

string

The key in the external bucket that contains this file.

The key in the external bucket that contains this file.

file_ttl

string (pangea-duration)

The explicit file TTL setting for this object.

The explicit file TTL setting for this object.

file_ttl_effective

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

The effective file TTL setting for this object, either explicitly set or inherited (see file_ttl_from_id.)

file_ttl_from_id

string

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

The ID of the object the expiry / TTL is set from. Either a service configuration, the object itself, or a parent folder.

• minLength: 36

• maxLength: 36

folder

string

The full path to the folder the object is stored in.

The full path to the folder the object is stored in.

id

string

The ID of a stored object.

• minLength: 36

The ID of a stored object.

• minLength: 36

md5

string

The MD5 hash of the file contents. Cannot be written to.

The MD5 hash of the file contents. Cannot be written to.

metadata

object

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

A set of string-based key/value pairs used to provide additional data about an object.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

metadata_protected

object

Protected (read-only) metadata.

• maxProperties: 256

Protected (read-only) metadata.

• maxProperties: 256

Pattern Property: ^.{1,64}$

string

• minLength: 1

• maxLength: 64

• minLength: 1

• maxLength: 64

name

string

The name of the object.

The name of the object.

parent_id

string

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

The parent ID (a folder). Blanks means the root folder.

• minLength: 36

sha256

string

The SHA256 hash of the file contents. Cannot be written to.

The SHA256 hash of the file contents. Cannot be written to.

sha512

string

The SHA512 hash of the file contents. Cannot be written to.

The SHA512 hash of the file contents. Cannot be written to.

size

integer

The size of the object in bytes.

The size of the object in bytes.

tags

array<string>

A list of user-defined tags

A list of user-defined tags

tags_protected

array<string>

Protected (read-only) flags.

Protected (read-only) flags.

type

string

The type of the item (file or dir). Cannot be written to.

The type of the item (file or dir). Cannot be written to.

updated_at

string (date-time)

The date and time the object was last updated.

The date and time the object was last updated.

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"

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"

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"

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"

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.

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 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	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}.
ShareUploadTimedOut	408	The upload operation timed out.
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