The VPS GB API and Terraform
Everything you can do in your account can be scripted with the VPS GB API, from your own code, CI or Terraform.
Where to start
- API & Terraform is the starting point: the base address, how to sign requests with a token, the tools, and how billing works for things you order through the API.
- API reference lists every endpoint, with a console to try calls with your token. You need to be signed in to see it.
- API access is where you create, see and revoke tokens.
This page does not repeat those; they are kept up to date with the API itself.
Creating a token
- Open API access.
- Choose what the token may do (read-only, full access, or your own choice of scopes) and how long it lasts, from one hour to 90 days.
- Confirm with your password, and your two-step code if two-step verification is on.
- Copy the token. It is shown once.
"Full access" leaves out the scopes that reveal secrets, such as server access and storage keys; choose those individually if you need them. Anything that costs money needs its own ordering scope as well.
Tokens stop working when
- you revoke them, or they expire;
- you reset your password;
- you turn two-step verification off.
Keep tokens out of your code and repositories. Anything done with a token is treated as done by you.