Module servers_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

AddServerError

struct for typed errors of method add_server

CacheServerError

struct for typed errors of method cache_server

CreateSyncError

struct for typed errors of method create_sync

DeleteServerError

struct for typed errors of method delete_server

EditServerError

struct for typed errors of method edit_server

EditServerSettingError

struct for typed errors of method edit_server_setting

GetPyMispVersionError

struct for typed errors of method get_py_misp_version

GetServerSettingError

struct for typed errors of method get_server_setting

GetServerSettingsError

struct for typed errors of method get_server_settings

GetServerUuidError

struct for typed errors of method get_server_uuid

GetServerVersionError

struct for typed errors of method get_server_version

GetServersError

struct for typed errors of method get_servers

GetWorkersError

struct for typed errors of method get_workers

ImportServerError

struct for typed errors of method import_server

KillAllWorkersError

struct for typed errors of method kill_all_workers

PullServerError

struct for typed errors of method pull_server

PushServerError

struct for typed errors of method push_server

RestartDeadWorkersError

struct for typed errors of method restart_dead_workers

RestartWorkersError

struct for typed errors of method restart_workers

StartWorkerError

struct for typed errors of method start_worker

StopWorkerError

struct for typed errors of method stop_worker

UpdateServerError

struct for typed errors of method update_server

Functions

add_server

cache_server

create_sync

delete_server

edit_server

edit_server_setting

get_py_misp_version

get_server_setting

get_server_settings

get_server_uuid

get_server_version

get_servers

get_workers

import_server

kill_all_workers

pull_server

push_server

restart_dead_workers

restart_workers

start_worker

stop_worker

update_server