help-header

How to create API Keys?

Application Programming Interface Key or API Key is a special identifier code to authenticate a user, developer, or program to an API. The API of ArvanCloud's services requires accurate authentication. There should be a specified API Key for a user to have access to ArvanCloud's APIs. 

To build an API Key, follow these steps:

  • Go to: ArvanCloud User Panel
  • Click on the user name at the top of the page > Profile
  • In the new window, click on API Keys > Generate New API Key
  • In the pop-up window, choose a Name for the API key.
  • Click on Create.

The API Keys section of the menu displays the built API Keys. Please note that once this window is closed, there is no way to restore the API Key. Manage to keep it safe. 

In case of forgetting it, the "Regenerate" box makes it possible to regenerate the forgotten keys. It will create a new key with the previous name. 

This key has a structure as below:

Apikey XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

To have access to ArvanCloud's APIs, use the key for the requests' Authorization header.

Keep in mind that the word "Apilkey" must be included in the key with a capital letter A.