Intelmq-API is a FastAPI based API to intelmq, a solution for IT security teams for collecting and processing security feeds
Project description
intelmq-api is a FastAPI based API for the intelmq project.
Extensive documentation regarding the installation, configuration and usage of the intelmq-api can be found in the intelmq documentation.
Development usage
You could create a preferred virtual environment, and then install the package using:
pip install -e .
For development purposes, you can run the API using the scripts/run_dev.sh script. It serves the API on the local 8000 port and watches for file changes, with the automated reloading on change.
The interactive documentation is served on the /docs endpoint.
To set the API configuration, please export the INTELMQ_API_CONFIG environment variable with path to the JSON config file in the shell you want to use. For the config reference, please check the intelmq_api/config.py and the example from contrib/api-config.json.
If you configured the session store, you will need to authorize every request. The /v1/login returns the authorization token. You can use the following command to register the user:
./scripts/intelmq-api-adduser --user UserName
Security note
Please be careful when deploying the API. At the current stage, it is not designed to run on publicly exposed endpoints without additional pre-cautions.
Type checking
The code can be typechecked with mypy. To run the type checker, use:
mypy intelmq_api/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for intelmq_api-3.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f284162f7cc6f2c426e3e6bf13607763a7aedfa34d0180d63fb1cea5d58c24d |
|
MD5 | cbb27c2cd5e27c0bf07e18bfa9dbb84d |
|
BLAKE2b-256 | 84ef5e3087a30a69aed1bf52dfb63a7e97d3ab4720b7efb7508d20e8890e4049 |