Access to API

API (Application Programming Interface) helps programs interact. It is a set of components describing how one program, like a bot or website, communicates with others. The platform uses an API-first model. This means that any user action in the portal interface can also be performed by an API user.

To start working with the platform using the API, you need to:

• Create an API user in your account.

• Use the Openstack documentation.

Creating API access

To create API access:

1. In the Control panel go to Account → Access, then go to the API tab.

2. Click on the Create user button.

3. Enter a user description to help distinguish this user from others and click Create.

4. Generate a unique password in the opening window.

Warning

IMPORTANT: Be sure to save the password, once you close the window it will be impossible to view or change it!

5. Click the Got It button. The new user’s record, including his login and author, will appear in the table.

Click on the user’s line to view its description and download RC files.

Hint

All control panel users with access to the personal account can view the list of users and create new ones.

You can create up to 10 API users.

Deleting API user

For security reasons and to preserve historical information, it is impossible to delete an API user without a trace, but it is possible to revoke access.

Warning

This action is irreversible! Before performing the operation, make sure that no critical automation depends on this API user.

To revoke an API user:

1. Go to Personal Account → Access, and click on the “API” tab;

2. Click the line of the user you want to revoke access for and click Terminate in the expanded card.

The user’s status will be changed to Terminated. The date of the revocation and the login of the user who took the action will appear in the user’s description.

Performing operations

Use the documentation at Openstack documentation and Terraform provider Openstack to perform operations on the infrastructure.