Direct Uploads

POST /direct_uploads

This endpoint manages direct-to-s3 uploads. You must POST metadata about the file you wish to upload directly. On success, a “blob” will be created in the database, which in this case is strictly only a reference to the location fo the file on S3. Despite the name, it does not contain the actual file data.

The request returns a signed AWS S3 url to which the actual file content should be posted. When that post has completed, then—and only then—you may submit a scan to the /scans endpoint to store a scan associated with the user.

Endpoint

POST /api/v2/direct_uploads

Parameters

Name Description type
blob[content_type] required Content Type string
blob[filename] required Filename string
blob[checksum] required MD5 Checksum string
blob[byte_size] required Size in bytes number

Request

Route

POST /api/v2/direct_uploads

Headers

Accept: application/json
Content-Type: application/json
Access-Token: GDDK_zHpqeheDQojg2k6ew
Client: v10eS9lxi_eroYvfzgMAEQ
Uid: test@example.com

Body

{
  "blob": {
    "content_type": "text/plain",
    "filename": "test.obj",
    "checksum": "ah59gycxlQLQuD7UA4GblA==",
    "byte_size": "1024"
  }
}

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Access-Token: GDDK_zHpqeheDQojg2k6ew
Token-Type: Bearer
Client: v10eS9lxi_eroYvfzgMAEQ
Expiry: 1906580685
Uid: test@example.com

Body

{
  "id": 418,
  "key": "TsMisyHxLLaTkjXkMT2fUGLd",
  "filename": "test.obj",
  "content_type": "text/plain",
  "metadata": {
  },
  "byte_size": 1024,
  "checksum": "ah59gycxlQLQuD7UA4GblA==",
  "created_at": "2020-06-01T21:44:45.498Z",
  "signed_id": "eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcUlCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--d9b84c2c7804f4de6b1d5218e54eb202c9feb75f",
  "direct_upload": {
    "url": "http://example.org:3002/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWRWSE5OYVhONVNIaE1UR0ZVYTJwWWEwMVVNbVpWUjB4a0Jqb0dSVlE2RVdOdmJuUmxiblJmZEhsd1pVa2lEM1JsZUhRdmNHeGhhVzRHT3daVU9oTmpiMjUwWlc1MFgyeGxibWQwYUdrQ0FBUTZEV05vWldOcmMzVnRTU0lkWVdnMU9XZDVZM2hzVVV4UmRVUTNWVUUwUjJKc1FUMDlCanNHVkE9PSIsImV4cCI6IjIwMjAtMDYtMDFUMjE6NDk6NDUuNDk5WiIsInB1ciI6ImJsb2JfdG9rZW4ifX0=--31f4d849d6d5a675e7268190fdd31a4a3237747d",
    "headers": {
      "Content-Type": "text/plain"
    }
  }
}