Uyarı (Alert)
Sorgular
- İlk Sorgular:
listAlert
: org'da kullanıcı tarafından görülebilen uyarıları listelergetAlert
: kimliğe göre bir uyarı alın: tüm uyarıları say (kullanımdan kaldırıldı)countAlert
: durumu yeni olan uyarıları say (kullanımdan kaldırıldı)countUnreadAlert
: vakalara aktarılan uyarıları say (kullanımdan kaldırıldı)countImportedAlert
- Uyarılarda mevcut sorgular:
observables
case
similarCases
similarAlerts
procedures
comments
- Ekstra veri:
similarCases
similarAlerts
importDate
caseNumber
status
procedureCount
Uyarı Oluştur
Bu uç nokta, TheHive'da alarm oluşturmaya olanak tanır. Hem çok parçalı hem de json girişini destekler. Dosyalarla gözlemler oluşturmak için çok parçalı bir gövde kullanmanız gerekir.
Çok parçalıyı kullanmak için, birkaç parça göndermeniz gerekir:
_json adında, oluşturulacak uyarının json'unu içeren bir veri parçası
- Gözlemlenebilirlerde, basit bir veri kullanmak istiyorsanız, gözlemlenebilirin veri alanını kullanın
- Bir dosya kullanmak istiyorsanız, ek alanında bir dize kullanın. Bu dize, dosyanızı içeren çok parçalı gövdenin bir bölümüne atıfta bulunmalıdır
- TheHive'da mevcut bir eki kullanmak istiyorsanız, ekin adını, içerik türünü ve kimliğini içeren bir nesne ayarlayın
POST /api/v1/alert/<alertId>/observable
uç noktasını kullanarak uyarınıza daha sonra her zaman gözlemlenebilirler ekleyebilirsiniz.
Curl ile
json kullanarak string türünde gözlemlenebilirler içeren bir uyarı oluşturma
curl http://<thehive_endpoint>/api/v1/alert -H 'Authorization: Bearer <api_key>' -X POST -H 'Content-Type: application/json' --data '
{
"type": "alertType",
"source": "test",
"sourceRef": "1",
"title": "alert title",
"description": "alert description",
"observables": [
{ "dataType": "url", "data": "http://example.org" },
{ "dataType": "mail", "data": "[email protected]" }
]
}
Çok parçalı kullanarak 2 gözlemlenebilir, bir url ve bir dosya içeren bir uyarı oluşturma
curl http://<thehive_endpoint>/api/v1/alert -H 'Authorization: Bearer <api_key>' -X POST -F _json='
{
"type": "alertType",
"source": "test",
"sourceRef": "1",
"title": "alert title",
"description": "alert description",
"observables": [
{ "dataType": "url", "data": "http://example.org" },
{ "dataType": "file", "attachment": "attachment0" }
]
}
' -F attachment0=@<file>
Python ile (istekler)
Gözlemlenebilir olarak iki dosya içeren bir uyarı oluşturun.
import json
import requests
# 'fileA' and 'fileB' are arbitrary names. You can choose your own.
# the name must be used as a key in the dictionary 'files'
observables = [
{'dataType': 'file', 'attachment': 'fileA'},
{'dataType': 'file', 'attachment': 'fileB'},
]
files = {
'fileA': open(path_to_fileA, 'rb'),
'fileB': open(path_to_fileB, 'rb')
}
alert = {
'title': 'my title',
'type': 'test',
'source': 'python',
'sourceRef': '1',
'description': 'description ...',
'observables': observables
}
# Send the request
response = requests.post(
f'{thehive_url}/api/v1/alert',
# send the files and the alert with the special part '_json'
files={
'_json': json.dumps(alert),
**files
},
headers={ 'Authorization': f'Bearer {thehive_api_key}' }
)
# check response code
response.raise_for_status()