Access to API

API (Application Programming Interface) is a set of components that describe how one computer program (bot, website, etc.) interacts with other programs.

The architecture of the platform is designed according to the API-first model, which implies that any user action in the portal interface can be technically performed by an API user.

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

• Create an API user in your account;

• Use the documentation https://docs.openstack.org/api-quick-start.

Creating API access

1. To create API access, 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. You will see a window with the generated unique password;

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 “I saved” 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.

Deleting an API user

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

Warning

This action is irreversible! Before performing the operation, make sure that no critical automations depend 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 “Revoke” in the expanded card.

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

Performing operations in API

Use the documentation at https://docs.openstack.org/api-quick-start/ and https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs to perform operations on the infrastructure.