Start a multipart upload directly to S3.

Changed on
post/api/v1/samples/init_multipart_upload

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/samples/init_multipart_upload
  • Auth
    API key in header X-API-Key

Request body

external_sample_idstring nullable
filenamestring required
interleavedboolean nullable
paired_end_filenamestring nullable
sample_idstring nullable

Example request

{
  "metadata": {
    "external_sample_id": "LIMS-2024-00123"
  },
  "project": {
    "__DOLLAR_REF__": "/api/v1/projects/a1b2c3d4e5f67890"
  }
}

Response

OK

callback_urlstring required
file_idstring required
paired_end_file_idstring nullable required
s3_bucketstring required
sample_idstring required
upload_aws_access_key_idstring required
upload_aws_secret_access_keystring required

Changes