API
Common information
HTTP Status
- 201 Created - Database or item was created successfully.
- 200 OK - No error.
- 403 Forbidden - The API key is wrong or you are editing a database that was created by other user.
- 400 Bad Request - Request parameter is invalid.
Database
Get
- HTTP Method
- GET
- URL
-
/databases.json (All Databases)
/databases/:database_name.json - Parameter
-
- page - Display 50 items per page if this parameter is given. Display all items if this parameter is not given.
Create
Creates new database. Returns "201 Created" and new database URL in location header when successful.
- HTTP Method
- POST
- URL
- /databases
- Parameter
-
- api_key - required
- database[name] - required - Cannot include "."(dot) and "/"(slash); cannot be numerals only; also, it must be unique.
- database[description] - Description of the database.
- database[required_keys] - required - Database's required keys. Please set a space-separated value if you want to set multiple keys.
- database[optional_keys] - Database's optinal keys. Please set a space-separated value if you want to set multiple keys.
- database[permit_other_keys] - Whether or not you permit addition of keys ohter than required keys and optional keys. This value is set to FALSE if this parameter is not given.
Update
Updates database configuration. Returns "200 OK" when successful.
- HTTP Method
- PUT
- URL
- /databases/:database_name
- Parameter
-
- api_key - required
- database[name] - Existing database name
- database[description] - Description of the database.
- database[required_keys] - required - Database's required keys. Please set a space-separated value if you want to set multiple keys.
- database[optional_keys] - Database's optinal keys. Please set a space-separated value if you want to set multiple keys.
- database[permit_oth