FAQ
Frequently Asked Questions
Technical questions
How do I authenticate API calls?
You make a POST request to https://api.armis.com/v3/oauth/token. See more details here.
How do I know which scopes are needed for a specific API endpoint?
The API ref page of each endpoint declares the required scopes.
For example, in the API ref page of the /assets/_bulk endpoint, you can see that the required scope is PERMISSION.DEVICE.MANAGE.EDIT.
Alternatively, when you make an API call without the right scopes, the error message from the server will let you know exactly which scopes are missing, for example:
The token is not authorized to access this resource. Missing scopes PERMISSION.DEVICE.MANAGE.EDIT
How do I extract data from Armis?
You can use the data-export functionallity which is documented here.
What are the best practices I should follow?
You can follow the check list that we curated exactly for this purpose. Note, that should you want to be officialy certified by Armis, this check list becomes a requirements list.
Do you have an SDK?
Yes, we have a Python SDK. However, its content is rather limited at the moment. You can read the documentation here.
What's the difference between API v1, v2, and v3?
API v3 is the latest iteration of our API. It brings enhancements to the old APIs (v1 and v2) in security, simplicity, consistency, and documentation. We acknowledge that not everything that can be done in v1 and v2 can be done in v3. If you're missing some key functionality from v1 or v2, please raise the topic in the discussions page.
I'm using API v1, can I use the same secret key to authenticate v3?
Yes, you can use the same secret key for authenticating both v1 and v3. However, the authentication mechanism is different - head to the authentication guide for details.
Where is the documentation of API v1 and v2?
You can access the documentation and API reference for v1 and v2 only if you have access to an Armis Centrix tenant. In that case, go to Settings > API Management, and there you'll find links to "API Docs" (i.e. API reference) and "API Guide" (i.e. documentation).
Can I get a access to a test tenant?
If you arrived here following a request from a mutual customer (or a prospect), please reach out to them for credentials for their tenant.
Commercial questions
What are the different types of partners you work with?
You can find them here.
Can I get an official certification, and put a badge in my site?
Yes, you can get the Integration Certification.
Updated about 1 month ago
