API documentation

miguel.tubia — Thu, 12 Jul 2018 11:04:18 GMT

Hi,

i want to query Mineneld using the API, in order to get indicators or information about the tool, to automate some reports.

For example, i need to know how many indicatores we have added in the last X days, or last month..., how many indicators are in some feed...

I know that Minemeld has an API, but I have not found documentation about it.

Thanks for your help.

Best regards.

Re: API documentation

xhoms — Mon, 23 Jul 2018 09:57:32 GMT

Hi @miguel.tubia,

I'm afraid such a documentation for the API does not exist yet. Your best choice as of today is to deep dive into the source code.

For example, the code at /flask/metricsapi.py contains the implementation of the "/metrics" entry point. Just perform a basic auth HTTPS call like the following one I did to get metrics for my node named "dshield_blocklist"

GET /metrics/dshield_blocklist HTTP/1.1
Host: myminemeld:8443
Authorization: Basic YWRtaW46bWluZW1lbGQ=

You'll get a response like:

{
    "result": [
        {
            "metric": "length",
            "values": [
                [
                    1532251260,
                    null
                ],
                [
                    1532253120,
                    null
                ],
                [
                    1532254980,
                    null
                ],
                [
                    1532256840,
                    null
                ],
                ...
            ]
        },
        {
            "metric": "update.tx",
            "values": [
                [
                    1532253120,
                    null
                ],
                [
                    1532254980,
                    null
                ],
                [
                    1532256840,
                    null
                ],
                [
                    1532258700,
                    null
                ],
                ...
            ]
        }
    ]
}

It contains samples with a timestamp and a difference from the previous sample.

Another chance (if you feel comfortable with UX development) is to deep dive into the minemeld-webui project and learn how these metrics are polled from the API and shown in the WebUI dashboard.

topic API documentation in General Topics

API documentation

Re: API documentation