Build on vBoxxCloud
Connect your own software to vBoxxCloud with the REST API. Automate users and organisations, move files in and out, create share links and follow activity, on the same European platform your team already uses.
# 1. Get an access token (password grant: scripts under your own account)
curl -X POST https://web.vboxx.nl/oauth/token \
-d grant_type=password \
-d client_id=anchor \
-d username=you@example.com \
-d password='your-password'
# 2. Call the API with the token
curl https://web.vboxx.nl/api/2/person \
-H "Authorization: Bearer <access_token>"- Base URL
- https://web.vboxx.nl/api/2
- Authentication
- OAuth2 bearer tokens
- Tokens
- Valid for about an hour, renewed with a refresh token
- Transport
- JSON over HTTPS only
What you can build
Most of what administrators and users do in vBoxxCloud is also available through the API.
Files and folders
Upload, download, move, rename and lock files and folders, and work with earlier versions.
View endpointsSharing
Create share links with an expiry date, download limit and recipients, and manage who they are shared with.
View endpointsOrganisations and policies
Create sub-organisations, set storage policies and read usage. Useful for partners who manage many customers.
View endpointsUsers, guests and groups
Create, update and remove accounts from your own HR system or user directory, and keep groups in sync.
View endpointsMachines and backups
Check desktop clients, map folders on file servers and create or restore backups.
View endpointsActivity and usage
Read the activity log and usage figures for reporting, audits or your own monitoring.
View endpointsGetting started
- 1
Register an application
An administrator opens the organisation settings, goes to API and chooses 'Register OAuth2 Client'. You get a client ID and a client secret.
How to register - 2
Get an access token
Apps that act for other users send them to the consent page (authorization code). Scripts under your own account can use the password grant.
Access tokens - 3
Call the API
Send the token in the Authorization header. When it expires, get a new one with the refresh token instead of asking for the password again.
Authenticating requests
Good to know
- Use a separate account for integrations, with only the rights it needs, so you can see and revoke what it does.
- Accounts with two-step verification send the code as auth_code when they request a token.
- GET /api/2/version needs no login: a quick way to test that you can reach the API.
- Store client secrets and refresh tokens like passwords: never in the browser or in source code.
Need a hand?
Our support team in the Netherlands helps with API access, OAuth2 clients and integrations. Building something for many customers? Have a look at the partner programme.
