Documentação da API
Exemplos de Endpoints
- Alerta
- GETObter Alertas
- POSTCriar Alerta
- DELExcluir Alerta
- PATCHAtualizar Alerta
- GETObter Alerta por Id
- POSTCriar Alerta com arquivos
- POSTAtualização em Massa de Alertas
- POSTCriar Caso a partir de Alerta
- POSTMesclar Alerta com Caso
- POSTMesclar Alertas com Caso
- POSTObter Alertas com Paginação
- GETObter Atividades por Alerta
- GET
- Caso
- Tarefa
Alerta
Obter Alertas
Returns a detailed list of all alerts, with an optional status as an input. The return object contains the alert details, including severity, status, and custom fields. The alerts are sorted by creation date.
GET
/
alerts
Copy
curl --request GET \
--url https://local.casebender.com:3000/api/alerts \
--header 'X-Api-Key: <api-key>'
Copy
[
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"status": {
"id": "<string>",
"stage": "New",
"label": "<string>",
"color": "<string>",
"value": "<string>",
"canDelete": true
},
"count": 123,
"severity": 123,
"type": "<string>",
"source": "<string>",
"sourceRef": "<string>",
"externalLink": "<string>",
"tlp": 123,
"pap": 123,
"customFields": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdAtLabel": "<string>",
"updatedAtLabel": "<string>",
"severityColor": "<string>",
"severityLabel": "<string>",
"case": null,
"teams": [
"<any>"
],
"tags": [
"<any>"
],
"organizations": [
"<any>"
],
"assignee": null,
"observables": [
"<any>"
],
"visibleToAllOrganizations": true,
"assigneeId": "<string>",
"createdById": "<string>",
"deletedAt": "<string>",
"aiInsights": {
"resolutionQuality": 123,
"complianceScore": 123,
"recommendations": [
"<string>"
],
"timeToResolution": 123,
"riskScore": 123,
"category": "<string>",
"trendAnalysis": {
"trend": "increasing",
"confidence": 123
},
"similarCases": [
{
"id": "<string>",
"similarity": 123,
"resolution": "<string>"
}
],
"complianceImpact": {
"frameworks": [
"<string>"
],
"severity": "low",
"details": "<string>"
},
"threatIntel": {
"knownThreatActors": [
"<string>"
],
"relatedMalware": [
"<string>"
],
"iocPatterns": [
"<string>"
],
"riskLevel": "low",
"confidence": 123,
"ttps": [
"<string>"
],
"malwareFamily": "<string>",
"targetedSystems": [
"<string>"
],
"exploitationRisk": 123
},
"patternAnalysis": {
"behavioralPatterns": [
"<string>"
],
"anomalyScore": 123,
"relatedTechniques": [
"<string>"
],
"mitreAttackPaths": [
"<string>"
],
"automationPotential": 123,
"falsePositiveRisk": 123,
"lateralMovementRisk": 123
},
"businessImpact": {
"financialRisk": 123,
"reputationalRisk": 123,
"operationalRisk": 123,
"dataRisk": 123,
"overallImpact": "low",
"estimatedLoss": 123,
"recoveryTime": 123,
"affectedServices": [
"<string>"
]
},
"timeToDetect": 123,
"priorityScore": 123,
"mitreReference": "<string>",
"affectedAssets": [
"<string>"
],
"attackVector": "<string>",
"remediationSteps": [
"<string>"
],
"falsePositiveProbability": 123,
"relatedAlerts": [
{
"id": "<string>",
"type": "<string>",
"severity": 123
}
],
"securityPosture": {
"vulnerabilities": [
{
"id": "<string>",
"cve": "<string>",
"severity": "low",
"description": "<string>",
"remediation": "<string>"
}
],
"exposedServices": [
"<string>"
],
"patchStatus": "up-to-date",
"configurationIssues": [
"<string>"
]
},
"incidentResponse": {
"status": "new",
"assignedTo": "<string>",
"timeline": [
{
"timestamp": 123,
"action": "<string>",
"actor": "<string>"
}
],
"containmentStrategy": "<string>",
"evidenceCollected": [
"<string>"
]
},
"recommendationItems": [
{
"id": "<string>",
"type": "immediate",
"description": "<string>",
"priority": 123,
"status": "pending",
"implementationComplexity": "low",
"estimatedEffort": 123,
"dependencies": [
"<string>"
]
}
],
"processingStatus": "pending"
},
"primaryAlertId": "<string>",
"slaConfig": null,
"slaDeadline": "<string>",
"slaStatus": "<string>",
"similarAlerts": [
"<any>"
],
"similarTo": [
"<any>"
],
"clientId": "<string>",
"client": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
]
Authorizations
Response
200
application/json
Successful response
The response is of type object[]
.
Copy
curl --request GET \
--url https://local.casebender.com:3000/api/alerts \
--header 'X-Api-Key: <api-key>'
Copy
[
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"status": {
"id": "<string>",
"stage": "New",
"label": "<string>",
"color": "<string>",
"value": "<string>",
"canDelete": true
},
"count": 123,
"severity": 123,
"type": "<string>",
"source": "<string>",
"sourceRef": "<string>",
"externalLink": "<string>",
"tlp": 123,
"pap": 123,
"customFields": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdAtLabel": "<string>",
"updatedAtLabel": "<string>",
"severityColor": "<string>",
"severityLabel": "<string>",
"case": null,
"teams": [
"<any>"
],
"tags": [
"<any>"
],
"organizations": [
"<any>"
],
"assignee": null,
"observables": [
"<any>"
],
"visibleToAllOrganizations": true,
"assigneeId": "<string>",
"createdById": "<string>",
"deletedAt": "<string>",
"aiInsights": {
"resolutionQuality": 123,
"complianceScore": 123,
"recommendations": [
"<string>"
],
"timeToResolution": 123,
"riskScore": 123,
"category": "<string>",
"trendAnalysis": {
"trend": "increasing",
"confidence": 123
},
"similarCases": [
{
"id": "<string>",
"similarity": 123,
"resolution": "<string>"
}
],
"complianceImpact": {
"frameworks": [
"<string>"
],
"severity": "low",
"details": "<string>"
},
"threatIntel": {
"knownThreatActors": [
"<string>"
],
"relatedMalware": [
"<string>"
],
"iocPatterns": [
"<string>"
],
"riskLevel": "low",
"confidence": 123,
"ttps": [
"<string>"
],
"malwareFamily": "<string>",
"targetedSystems": [
"<string>"
],
"exploitationRisk": 123
},
"patternAnalysis": {
"behavioralPatterns": [
"<string>"
],
"anomalyScore": 123,
"relatedTechniques": [
"<string>"
],
"mitreAttackPaths": [
"<string>"
],
"automationPotential": 123,
"falsePositiveRisk": 123,
"lateralMovementRisk": 123
},
"businessImpact": {
"financialRisk": 123,
"reputationalRisk": 123,
"operationalRisk": 123,
"dataRisk": 123,
"overallImpact": "low",
"estimatedLoss": 123,
"recoveryTime": 123,
"affectedServices": [
"<string>"
]
},
"timeToDetect": 123,
"priorityScore": 123,
"mitreReference": "<string>",
"affectedAssets": [
"<string>"
],
"attackVector": "<string>",
"remediationSteps": [
"<string>"
],
"falsePositiveProbability": 123,
"relatedAlerts": [
{
"id": "<string>",
"type": "<string>",
"severity": 123
}
],
"securityPosture": {
"vulnerabilities": [
{
"id": "<string>",
"cve": "<string>",
"severity": "low",
"description": "<string>",
"remediation": "<string>"
}
],
"exposedServices": [
"<string>"
],
"patchStatus": "up-to-date",
"configurationIssues": [
"<string>"
]
},
"incidentResponse": {
"status": "new",
"assignedTo": "<string>",
"timeline": [
{
"timestamp": 123,
"action": "<string>",
"actor": "<string>"
}
],
"containmentStrategy": "<string>",
"evidenceCollected": [
"<string>"
]
},
"recommendationItems": [
{
"id": "<string>",
"type": "immediate",
"description": "<string>",
"priority": 123,
"status": "pending",
"implementationComplexity": "low",
"estimatedEffort": 123,
"dependencies": [
"<string>"
]
}
],
"processingStatus": "pending"
},
"primaryAlertId": "<string>",
"slaConfig": null,
"slaDeadline": "<string>",
"slaStatus": "<string>",
"similarAlerts": [
"<any>"
],
"similarTo": [
"<any>"
],
"clientId": "<string>",
"client": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
]
Assistente
Responses are generated using AI and may contain mistakes.