Using Netlas for Automation
This section is designed to guide you through using the Netlas API effectively. You'll learn about the different approaches to automation, understand technical limitations, and how to handle errors effectively, ensuring you make the most of Netlas in your projects.
Automation Tools
Netlas offers three primary methods for automation through third-party applications or scripts:
- Netlas Python SDK: Ideal for Python developers looking for robust programming integration.
- Command Line Interface (CLI): Perfect for those who prefer scripting in Bash and require quick, scriptable access.
- Direct API Access: Offers the most flexible and universal method of automation across various platforms.
Each methoad is described in this manual with simultaneous examples.
There are also several unofficial libraries/packages for Go and Javascript written by independent developers.
Contents Introduction
This Automation section consists of:
- How to Get an API Key: Steps to obtain your API key for accessing Netlas data and tools.
- Setting Up SDK & CLI: Instructions on installing and configuring the Netlas SDK and CLI tool.
- Search Tools API: Information on using the Search Tools API for data queries.
- Scanner API: How to control Netlas Private Scanner via API.
- Python SDK Specification: Documentation on the main classes and their methods included in Netlas SDK.
- API Specification: Specification of all available API endpoints, parameters, and outputs.
Additional Resources
Netlas is already integrated into many popular utilities and applications used by information security professionals. Please refer to the Netlas website for a list of integrations.
These resources will be useful for development in addition to this documentation:
- Netlas Cookbook contains a lot of automation examples, both using the command line and the Python SDK. Perhaps you will find a ready-made recipe there.
- Netlas Scripts repo contains automations, which are discussed in detail in our blog. Use these scripts as examples.
- Netlas Community Server on Discord. Here you can ask for advice, get support, or just chat with experts and developers.
Developer License
The Netlas team welcomes the independent development of Netlas-based tools.
If you are a developer of any security related software and want to integrate Netlas into it, please apply for a free Developer license. With the Developer license, you have virtually unlimited access to Netlas API and our support. You can also apply if you want to develop an integration for a third-party solution, but only if you plan to publish this integration for everyone.
Please, make sure you provide a link to the product page or Github repository in the "Your question" field.