An API (Application Programming Interface) is a program that allows different applications to communicate with each other to share information and functionalities.
In this sense, our API allows you to manage everything you can do in the Clouding panel. From creating servers from different sources, to archiving/unarchiving, creating snapshots, activating backups, adding firewall rules, etc.
In the following tutorial we are going to explain how to generate an API key from the Clouding portal to be able to use it for all the actions available for our API.
Create API key
To generate the API key, you will need to log in to our Clouding account. Go to the Account > API section.
The first time you access the API section, you will see the following message:
Click on the icon to create a new API key. You will need to add an identifying name:
Then you must select the group of actions you want to add to this API key:
- Read-only: With this group of actions you will be able to make queries (GET) but you will not be able to create, modify or delete (POST).
- Administrator: With this group of actions you will be able to make all the requests to the API, both queries and create, modify or delete.
- Operator: With this group of actions you will be able to perform basic tasks such as start, stop, restart, forced restart, archive/unarchive, but you will not be able to create, modify or delete.
Once you are clear which group of actions you need, you must check the option and click on the Submit button. Once generated, the API key will be displayed:
Important
Remember to save the API key in a safe place, as it will only be displayed once and then you will not be able to see it again.
At this point, you can use the API key to use the Clouding API. With the API key you can create a server or archive or unarchive a server, as well as resize a server.
Please refer to the official Clouding API documentation.
We recommend you to follow this article and for more information refer to the official Clouding API documentation for more details.
We hope we helped you, have you tried it? Leave us your comments 🙂 🙂 .
Remember, if you have any questions about this article or any other topic related to your Clouding servers, write us at soporte@clouding.io. We are at your disposal for anything you need!