API Reference
Last updated 19 November 2026
Where the reference is
The reference for the REST API is at api.africloud.com/docs. It lists the public endpoints with their parameters and responses, and needs no login to read.
The same reference is published as an OpenAPI 3.0 specification at api.africloud.com/v1/openapi.yaml, for code generators and API clients.
All endpoints sit under https://api.africloud.com/v1.
Create an API key
- In the dashboard sidebar, under Settings, open API Keys.
- Click Create Key, enter a name for the key and your current password (and, if two-factor authentication is on, a code from your authenticator app or one of your recovery codes), and click Create.
- Copy the key from the API Key Created dialog. It is shown only once; if you lose it, delete the key and create a new one.
Each key in the list has a shield icon (IP Restrictions). Use it to limit the key to specific IP addresses or CIDR ranges, one per line; leave the box empty to allow any address. Use the bin icon to delete a key you no longer need; deleting asks for your password, and a code when two-factor authentication is on, in the same way. We email you whenever a key is created on your account, and a password reset deletes every key.
Authenticate your requests
Send the key as a bearer token in the Authorization header. For example, to list your servers:
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.africloud.com/v1/vms
A new key can read your resources but not change them. In the Access list you choose, for each area, No access, Read or Read and write, or tick Full access for all resources, including changes; choose only what the key needs. Treat it like a password: anyone holding it can act on your account, so keep keys out of source code and shared files.