HTTP API

Basics

(about admin, auth, boxes and typical call flow order)

(about wrapping HTTP in Websockets)

Tokens

(about auth)

(about tokens)

Typical Call Flow

(fill in)

Admin Calls

Admin calls, where the path of the URI starts with /admin/.

GET

• create_root_box
• list_boxes
• delete_box
• create_box
• list_users
• list_apps
• info

OPTIONS

For CORS compatibility.

Auth Calls

Auth calls, where the path of the URI starts with /auth/.

GET

Actions

• whoami
• login
• login_keys
• login_openid
• openid_process
• get_token
• logout

OPTIONS

For CORS compatibility.

Box Calls

Calls on a box, where the path of the URI starts with /boxname/.

GET

Get objects or perform other actions:

Actions

• query
• diff
• apply_diff
• get_object_ids
• set_acl

Fields:

Either target_username must be set to a user, or unauth_user must be set to true.

target_username - The username that this ACL applies to.

unauth_user - Set to true to specify that this ACL applies to public not logged in sessions (i.e., to serve linked data).

acl - The ACL itself, in the following format:

{'read': true,
 'write': false,
 'control': false
}

• get_acls
• get_version
• generate_new_key
• link_remote_box
• files

PUT

To add/update an object.

DELETE

To delete an object.

OPTIONS

For CORS compatibility.