You'll need an Access Token if you want to use the API to access your own Maxihost data – for example, if you use the API with your own scripts to get data from your Maxihost account.

Setting up API Keys

🚧

API Keys should be kept private

API Keys allow access to your private data in Maxihost. They should not be shared outside of your company. We cannot stress enough how important it is for you not to share your API Key with anyone. In case you suspect your API key has been leaked, you can regenerate or delete it on the dashboard and this will revoke access for that key.

To generate an API token, go to the Settings page on the dashboard by clicking on the Settings & Billing menu and then on the API Keys tab.

API Keys on the dashboardAPI Keys on the dashboard

API Keys on the dashboard

Using your API Key

Once you have created your Access Token you will see it in the same section of your Dashboard. You can edit or delete the token from here.

To use your Access Token simply provide it as part of the authorization header when you make a request. Access Tokens use the bearer authorization header when you make a request.

For more info on the bearer token framework please see the official specification.

$ curl \
-s https://api.maxihost.com/user/profile \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-H 'Accept:application/json'