Document

obniz Hardware and cloud specifications.


Repository API

Cloud users are granted to use cloud data storage.
Storage capacity is depend on how many obniz a user has.

Also, It provide REST API.

Upload

Uploading a file to repository with a file.

POST /users/me/repo/{file_name}

Request Parameter

Name Type Optional Description
access_token Cookie Required String of user's access token
file Body/Multipart-form Required The file to be uploaded

Response

json format.

Status Description
200 Success
400 Format Error
403 Invalid access token / capacity full

Download

Download a file from repository.

GET /users/me/repo/{file_name}

or

GET /users/{user_id}/repo/{file_name}

Request Parameter

Name Type Optional Description
access_token Cookie Optional String of user's access token

Response

File it self. octet-stream.

Status Description
200 Success
403 Invalid access token
404 Not Found