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: M06VH7NkIREfLiNsagcwvQ
Client: hkHS5eFsbVYXcuOCP79sew
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: M06VH7NkIREfLiNsagcwvQ
Token-Type: Bearer
Client: hkHS5eFsbVYXcuOCP79sew
Expiry: 1889903599
Uid: test@example.com

Body

{
  "id": 4936,
  "key": "sJ6QHpj7y2NXNrXTGMGjPKCr",
  "filename": "test.obj",
  "content_type": "text/plain",
  "metadata": {
  },
  "byte_size": 1024,
  "checksum": "ah59gycxlQLQuD7UA4GblA==",
  "created_at": "2019-11-20T21:13:19.189Z",
  "signed_id": "eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBa2dUIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--0eab6bd51109c5cb97c03dfee9d96e0412c64b66",
  "direct_upload": {
    "url": "http://example.org:3002/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWRjMG8yVVVod2FqZDVNazVZVG5KWVZFZE5SMnBRUzBOeUJqb0dSVlE2RVdOdmJuUmxiblJmZEhsd1pVa2lEM1JsZUhRdmNHeGhhVzRHT3daVU9oTmpiMjUwWlc1MFgyeGxibWQwYUdrQ0FBUTZEV05vWldOcmMzVnRTU0lkWVdnMU9XZDVZM2hzVVV4UmRVUTNWVUUwUjJKc1FUMDlCanNHVkE9PSIsImV4cCI6IjIwMTktMTEtMjBUMjE6MTg6MTkuMTkwWiIsInB1ciI6ImJsb2JfdG9rZW4ifX0=--220a312cd1204a9420da5ee51f4f607206732be6",
    "headers": {
      "Content-Type": "text/plain"
    }
  }
}