Skip to main content

Secure Share - General API Reference

Beta

Run In Postman
Base URL​

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

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

Response

v-1-beta-buckets

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

Get information on the accessible buckets.

object

Pangea standard response schema

object

A response to a buckets call.

array<object>

A list of available buckets.

string

The ID of a share bucket resource.

  • minLength: 36

  • maxLength: 36

boolean

If true, is the default bucket.

string

The bucket's friendly name.

array<string>
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"
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"
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"
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"
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/v1beta/delete
curl -sSLX POST 'https://share.aws.us.pangea.cloud/v1beta/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

v-1-beta-delete

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

string

The ID of the object to delete.

  • minLength: 36
boolean

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

string

The path of the object to delete.

  • minLength: 1

  • maxLength: 256

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

Pangea standard response schema

object
integer

Number of objects deleted.

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

Response

v-1-beta-folder-create

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

string

The name of an object.

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

string

The ID of a stored object.

  • minLength: 36
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

array<string>

A list of user-defined tags

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

Pangea standard response schema

object

Information on the created folder.

object
integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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

Response

v-1-beta-get

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

string

The ID of the object to retrieve.

  • minLength: 36
string

The path of the object to retrieve.

  • minLength: 1

  • maxLength: 256

string

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

string

The requested transfer method for the file data.

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

Pangea standard response schema

object

File information.

string

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

object
integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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

Response

v-1-beta-get-archive

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

array<string>

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

string

The format to use to build the archive.

string

The requested transfer method for the file data.

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

Pangea standard response schema

object

A response to a get_archive call.

integer

Number of objects included in the archive.

string

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

array<object>

A list of all objects included in the archive.

integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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

Response

v-1-beta-list

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

object
string (date-time)

Only records where created_at equals this value.

string (date-time)

Only records where created_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where created_at is less than this value.

string (date-time)

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

string

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

string

Only records where id equals this value.

array<string>

Only records where id equals one of the provided substrings.

string

Only records where name equals this value.

array<string>

Only records where name includes each substring.

array<string>

Only records where name equals one of the provided substrings.

string

Only records where parent_id equals this value.

array<string>

Only records where parent_id equals one of the provided substrings.

integer

Only records where size equals this value.

integer

Only records where size is greater than this value.

integer

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

integer

Only records where size is less than to this value.

integer

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

array<string>

A list of tags that all must be present.

string

Only records where type equals this value.

array<string>

Only records where type includes each substring.

array<string>

Only records where type equals one of the provided substrings.

string (date-time)

Only records where updated_at equals this value.

string (date-time)

Only records where updated_at is greater than this value.

string (date-time)

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

string (date-time)

Only records where updated_at is less than this value.

string (date-time)

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

boolean

If true, include the external_bucket_key in results.

string

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

string

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

string

Which field to order results by.

integer

Maximum results to include in the response.

  • minimum: 1
string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

Pangea standard response schema

object
integer

The total number of objects matched by the list request.

string

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

array<object>
integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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

Response

v-1-beta-put

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.

required parameters

object
object
string

The transfer method used to upload the file data.

integer

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

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

string

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

string

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

string

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

string

The name of the object to store.

string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

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.

string

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

  • minLength: 36
string

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

  • minLength: 1

  • maxLength: 256

string

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

string

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

string

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

string

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

string

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

array<string>

A list of user-defined tags

object

Pangea standard response schema

object
object

The object that was created.

integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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

Response

v-1-beta-update

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

string

An identifier for the file to update.

  • minLength: 36
string

An alternative to ID for identifying the target file.

  • minLength: 1

  • maxLength: 256

string

The bucket to use, if not the default.

  • minLength: 36

  • maxLength: 36

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

string

Protect the file with the supplied password.

string

The algorithm to use to password protect the file.

array<string>

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

string

Sets the object's Name.

object

Set the object's metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

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
string

  • minLength: 1

  • maxLength: 64

string

Remove the supplied password from the file.

array<string>

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

string

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

array<string>

Set the object's tags.

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.

object

Pangea standard response schema

object
object
integer

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

string (date-time)

The date and time the object was created.

string (date-time)

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

string

The key in the external bucket that contains this file.

string (pangea-duration)

The explicit file TTL setting for this object.

string (pangea-duration)

The effective file TTL setting for this object, either explicitly set or inherited (see 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 full path to the folder the object is stored in.

string

The ID of a stored object.

  • minLength: 36
string

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

object

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

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

object

Protected (read-only) metadata.

  • maxProperties: 256
string

  • minLength: 1

  • maxLength: 64

#/components/schemas/Name

The name of the object.

string

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

  • minLength: 36
string

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

string

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

integer

The size of the object in bytes.

array<string>

A list of user-defined tags

array<string>

Protected (read-only) flags.

string

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

string (date-time)

The date and time the object was last updated.

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"
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"
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"
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"
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 Codes​
StatusStatus CodeDescription
ShareBadTransferMethod400

A bad or unsupported transfer method was specified.

ShareCantDeleteRoot400

You cannot delete the root folder.

ShareExternalBucketNotVerified400

An external bucket cannot be used unless it has been verified.

ShareFileMalicious400

The file was malicious.

ShareIDMismatch400

An ID was supplied that didn't match the associated object.

ShareImmutableError400

Immutable {subject} ($-prefixed) cannot be modified or removed.

ShareLoopDetected400

A folder path naming loop was detected.

ShareMissingPayload400

An API request was submitted without a file paylod. Check the API documentation and try again.

ShareNameMismatch400

A name was supplied that didn't match the associated object. If updating an object ty path, the name is not required.

ShareNoDefaultBucket400

No bucket_id supplied and no default bucket.

ShareNotEmpty400

A folder is not empty.

ShareParentIDDoesNotExist400

The supplied parent ID does not exist.

SharePathContainsNonFolder400

The supplied path contains a non folder part: {subject}

ShareTypeMismatch400

You are trying to replace or update an object of one type (file, folder, etc.) to another. This is not allowed.

ShareUnableToScanBlocked400

Configuration prevents unscannable files from being uploaded.

ShareUnsupportedHashes400

One or more unsupported hashes were used: {subject}

ShareUpdatedAtMismatch400

The supplied updated at timestamp didn't match the stored timestamp. Refresh your data and try again.

ShareVaultNotConfigured400

An operation requiring vault was performed, but vault has not been configured.

ShareVaultPasswordDoesNotExist400

No password exists on the associated object.

ShareVaultPasswordExists400

A password already exists on the associated object.

ShareVaultPasswordMissing400

An object is password protected and no password was provided.

ShareVaultPasswordNotAllowed400

Encryption is not supported on an object, password not allowed.

ShareVaultPasswordWrong400

An object is password protected and an invalid password was provided.

ShareVaultProblem400

A vault problem was encountered. Check that your token has appropriate vault permissions.

ShareForbiddenFormat403

The uploaded file format {subject} is not configured as an allowed format.

ShareForbiddenMedia403

The uploaded file media type ({action}) and format ({subject}) is not allowed by configuration.

ShareSourceURLRejected403

The provided source URL was rejected.

ShareTooLarge403

The uploaded object exceeds the maximum configured size of {subject}.

SharePutObjectExists409

An object with this Name already exists in this folder.

ShareTransferFailed503

A temporary error occurred while handling an object.

Was this article helpful?

Contact us