Mihari API (0.0.1)

Download OpenAPI specification:Download

alerts

Operations about alerts

Create an alert

Request Body schema: application/json
required

ruleId required	string
artifacts required	Array of strings
source	string

Responses

Request samples

Payload

Content type

application/json

{"ruleId": "string",
"artifacts": ["string"
],
"source": "string"
}

Response samples

201
404

Content type

application/json

{"id": 0,
"ruleId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"artifacts": [{"id": 0,
"data": "string",
"dataType": "string",
"source": "string",
"query": "string",
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
]
}

List/search alerts

query Parameters

q	string Default: ""
page	integer <int32> Default: 1
limit	integer <int32> Default: 10

Responses

Response samples

200

Content type

application/json

[{"total": 0,
"currentPage": 0,
"pageSize": 0,
"results": [{"id": 0,
"ruleId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"artifacts": [{"id": 0,
"data": "string",
"dataType": "string",
"source": "string",
"query": "string",
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
]
}
]
}
]

Delete an alert

path Parameters

id

required

integer <int32>

Responses

Response samples

204
404

Content type

application/json

{"message": "string"
}

Get an alert

path Parameters

id

required

integer <int32>

Responses

Response samples

200
404

Content type

application/json

{"id": 0,
"ruleId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"artifacts": [{"id": 0,
"data": "string",
"dataType": "string",
"source": "string",
"query": "string",
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
]
}

artifacts

Operations about artifacts

Delete an artifact

path Parameters

id

required

integer <int32>

Responses

Response samples

204
404

Content type

application/json

{"message": "string"
}

Get an artifact

path Parameters

id

required

integer <int32>

Responses

Response samples

200
404

Content type

application/json

{"id": 0,
"data": "string",
"dataType": "string",
"source": "string",
"query": "string",
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
],
"autonomousSystem": {"asn": 0
},
"geolocation": {"country": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"whoisRecord": {"domain": "string",
"createdOn": "2019-08-24",
"updatedOn": "2019-08-24",
"expiresOn": "2019-08-24",
"registrar": { },
"contacts": [{ }
],
"createdAt": "2019-08-24T14:15:22Z"
},
"reverseDnsNames": [{"name": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"dnsRecords": [{"resource": "string",
"value": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"cpes": [{"cpe": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"ports": [{"port": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
]
}

Enrich an artifact

path Parameters

id

required

integer <int32>

Responses

Response samples

201
404

Content type

application/json

{"message": "string"
}

List/search artifacts

query Parameters

q	string Default: ""
page	integer <int32> Default: 1
limit	integer <int32> Default: 10

Responses

Response samples

200

Content type

application/json

[{"total": 0,
"currentPage": 0,
"pageSize": 0,
"results": [{"id": 0,
"data": "string",
"dataType": "string",
"source": "string",
"query": "string",
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z"
}
]
}
]

configs

Operations about configs

List configs

list configs

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"type": "string",
"items": [{ }
],
"configured": true
}
]

ip_addresses

Operations about ip_addresses

Get IP address data

path Parameters

ip

required

string

Responses

Response samples

200
404
422

Content type

application/json

{"countryCode": "string",
"asn": 0,
"loc": "string"
}

rules

Operations about rules

Delete a rule

path Parameters

id

required

string

Responses

Response samples

204
404

Content type

application/json

{"message": "string"
}

Get a rule

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"yaml": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
]
}

Update a rule

Request Body schema: application/json
required

yaml

required

string

Responses

Request samples

Payload

Content type

application/json

{"yaml": "string"
}

Response samples

201
404
422

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"yaml": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
]
}

Create a rule

Request Body schema: application/json
required

yaml

required

string

Responses

Request samples

Payload

Content type

application/json

{"yaml": "string"
}

Response samples

201
400
422

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"yaml": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
]
}

List/search rules

query Parameters

q	string Default: ""
page	integer <int32> Default: 1
limit	integer <int32> Default: 10

Responses

Response samples

200

Content type

application/json

[{"total": 0,
"currentPage": 0,
"pageSize": 0,
"results": [{"id": "string",
"title": "string",
"description": "string",
"yaml": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
]
}
]
}
]

Run a rule

Search by a rule

path Parameters

id

required

string

Responses

Response samples

201
404

Content type

application/json

{"message": "string",
"queued": true
}

Mihari API (0.0.1)

alerts

Create an alert

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List/search alerts

query Parameters

Responses

Response samples

Delete an alert

path Parameters

Responses

Response samples

Get an alert

path Parameters

Responses

Response samples

artifacts

Delete an artifact

path Parameters

Responses

Response samples

Get an artifact

path Parameters

Responses

Response samples

Enrich an artifact

path Parameters

Responses

Response samples

List/search artifacts

query Parameters

Responses

Response samples

configs

List configs

Responses

Response samples

ip_addresses

Get IP address data

path Parameters

Responses

Response samples

rules

Delete a rule

path Parameters

Responses

Response samples

Get a rule

path Parameters

Responses

Response samples

Update a rule

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a rule

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List/search rules

query Parameters

Responses

Response samples

Run a rule

path Parameters

Responses

Response samples

tags

Delete a tag

path Parameters

Responses

Response samples

List tags

query Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required