Uploading filesΒΆ

One of the basic usages of File API is to upload and store a file for later retrieval. It has two APIs to upload a file. The first API is described as follows:

POST /v1/file/(file_id)

Upload a file with a given file_id. You are required to generate a file_id and post the content of file in request body with the correct MIME type set as Content-Type header.

Example request:

POST https://filestore.project-name.hasura-app.io/v1/file/05c40f1e-cdaf-4e29-8976-38c899 HTTP/1.1
Content-Type: image/png
Authorization: Bearer <token>

<content-of-file-as-body>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "file_id": "05c40f1e-cdaf-4e29-8976-38c899",
  "content_type": "image/png",
  "file_status": "uploaded",
  "file_size": 351667,
  "user_id": 42,
  "user_role": "user",
  "created_at": "2017-04-25T08:26:22.834266+00:00"
}

The second API is described as follows.

POST /v1/file/

Post the content of file in request body with the correct MIME type set as Content-Type header.

Example request:

POST https://filestore.project-name.hasura-app.io/v1/file HTTP/1.1
Content-Type: image/png
Authorization: Bearer <token>

<content-of-file-as-body>

Response contains file_id generated by filestore service.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "file_id": "05c40f1e-cdaf-4e29-8976-38c899",
  "content_type": "image/png",
  "file_status": "uploaded",
  "file_size": 351667,
  "user_id": 42,
  "user_role": "user",
  "created_at": "2017-04-25T08:26:22.834266+00:00"
}

Authorization header is not required if the request is being made from a browser, since Cookie will be set.

Note

By default, File APIs are only accessible to those users with admin role. Goto Permissions tab under File Service in the console and enable Private webhook to enable user role also to upload and download files. This default permissions are based only on role and not on user ID. Hence, anybody with a user role can download a file another user has uploaded. For a more fine grained access control, refer to Authorization webhooks.

Uploaded files will be visible on the API console.

For more details, see API reference.

« previous | next »
Want to contribute or report missing content? Check out the github repo for docs.
Powered by Sphinx. Copyright © 2019 Hasura.