Module events_api

MISP Automation API

Getting Started MISP API allows you to query, create, modify data models, such as Events, Objects, Attributes. This is extremly useful for interconnecting MISP with external tools and feeding other systems with threat intel data. It also lets you perform administrative tasks such as creating users, organisations, altering MISP settings, and much more. To get an API key there are several options: * [UI] Go to My Profile -> Auth Keys section and click on + Add authentication key * [UI] As an admin go to the the Administration -> List Users -> View page of the user you want to create an auth key for and on the Auth keys section click on + Add authentication key * [CLI] Use the following command: ./app/Console/cake user change_authkey [e-mail/user_id] * API Provided you already have an admin level API key, you can create an API key for another user using the [POST]/auth_keys/add/{{user_id}} endpoint. > NOTE: The authentication key will only be displayed once, so take note of it or store it properly in your application secrets. #### Accept and Content-Type headers When performing your request, depending on the type of request, you might need to explicitly specify in what content type you want to get your results. This is done by setting one of the below Accept headers: Accept: application/json Accept: application/xml When submitting data in a POST, PUT or DELETE operation you also need to specify in what content-type you encoded the payload. This is done by setting one of the below Content-Type headers: Content-Type: application/json Content-Type: application/xml Example: curl --header \"Authorization: YOUR_API_KEY\" \\ --header \"Accept: application/json\" \\ --header \"Content-Type: application/json\" https://<misp url>/ > NOTE: By appending .json or .xml the content type can also be set without the need for a header. #### Automation using PyMISP PyMISP is a Python library to access MISP platforms via their REST API. It allows you to fetch events, add or update events/attributes, add or update samples or search for attributes. ### FAQ * Dev FAQ * GitHub project FAQ

The version of the OpenAPI document: 2.4

Generated by: https://openapi-generator.tech

Enums

AddEventError

struct for typed errors of method add_event

DeleteEventError

struct for typed errors of method delete_event

EditEventError

struct for typed errors of method edit_event

EnrichEventError

struct for typed errors of method enrich_event

GetEventByIdError

struct for typed errors of method get_event_by_id

GetEventsError

struct for typed errors of method get_events

PublishEventError

struct for typed errors of method publish_event

RestSearchEventsError

struct for typed errors of method rest_search_events

SearchEventsError

struct for typed errors of method search_events

TagEventError

struct for typed errors of method tag_event

UnpublishEventError

struct for typed errors of method unpublish_event

UntagEventError

struct for typed errors of method untag_event

Functions

add_event

delete_event

edit_event

enrich_event

get_event_by_id

get_events

publish_event

rest_search_events

This is the recommended endpoint for searching events.

search_events

tag_event

unpublish_event

untag_event