Wallarm API overview¶
Wallarm API provides interaction between components of the Wallarm system. You can use Wallarm API methods to create, get, or update the following instances:
Description of API methods is given in the API Reference by the link:
API requests are sent to the following URL:
Authentication of API requests¶
You must be a verified user to make Wallarm API requests. The method of API requests authentication depends on the client sending the request:
API Reference UI¶
A token is used for request authentication. The token is generated after successful authentication in your Wallarm account.
Sign in to your Wallarm account using the link:
Refresh the API Reference page using the link:
Go to the required API method → the Try it out section, input parameter values, and Execute the request.
Your own client¶
API credentials and SSO
When SSO is enabled for the user, authentication for requests to Wallarm API via UUID and secret key becomes unavailable for this user. Find detailed information in the SSO configuration article.
Your UUID and secret key are used for request authentication.
Copy the UUID value.
Get the Secret key value:
- If you know the secret key value, then you can continue using the known value. The Wallarm Console displays the encrypted value of your active secret key.
If you do not know the secret key value or it was lost, to generate the new secret key:
- Click Renew secret key.
- Confirm by entering your password.
- As soon as the new key is generated, copy its value. The secret key value will not be shown again.
Reusing the secret key value
The button Renew secret key generates the new value of the secret key and invalidates the previous value. To use the secret key securely:
- Write down the key value in a secure place. The secret key value will not be shown again.
- Reuse the stored key value in all requests to Wallarm API.
- If you generated the new key value, make sure the previous value is not used in other API clients. If the previous value is in use, replace it with the newly generated secret value.
Send the required API request passing the following values:
- UUID in the
- Secret key in the
- UUID in the
Wallarm approach to API development and documentation¶
Wallarm API Reference is a single page application (SPA) with all displayed data being dynamically fetched from the API. This design drives Wallarm to use the API-first approach when new data and functionality is initially made available in the public API and as the next step is described in the API Reference. Normally all new functionality is released in parallel in both public API and API Reference, but sometimes new API changes are released ahead of API Reference changes, and some functionality is available via the public API only.
Wallarm API Reference is generated from the Swagger file using the Swagger UI tool. API Reference provides an easy way to learn about available API endpoints, methods, and data structures. It also provides a simple way to try all available endpoints.