io.enterpriseai.resources.IncidentsClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/IncidentsClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class IncidentsClient
Incidents and containment actions.
Constructor IncidentsClient
IncidentsClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
IncidentsClient.action
JsonNode action(String id, Object body)
Run a containment action. Runs a containment action through the domain that owns the target and records it on the incident. Needs tenant_admin or security_officer.
Route: /v1/incidents/{incident_id}/actions (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the incident. | |
body | Object | yes | Action, target and reason. |
Returns: JsonNode. Decoded JSON answer of the operation "Run a containment action".
Raises: the typed errors of the transport (Errors).
IncidentsClient.action
JsonNode action(String id, Object body, RequestOptions options)
Run a containment action. Runs a containment action through the domain that owns the target and records it on the incident. Needs tenant_admin or security_officer.
Route: /v1/incidents/{incident_id}/actions (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the incident. | |
body | Object | yes | Action, target and reason. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Run a containment action".
Raises: the typed errors of the transport (Errors).
IncidentsClient.create
JsonNode create(Object body)
Open an incident. Opens an incident in status open, adds the created entry to the timeline and forwards it to the SIEM. Needs tenant_admin, security_officer, developer or agent. An unknown severity answers 400 invalid_request. Writes the audit event incident.create. The answer (201) carries the incident with its timeline.
Route: /v1/incidents (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Title, severity, description, category, resources and assignee. |
Returns: JsonNode. Decoded JSON answer of the operation "Open an incident".
Raises: the typed errors of the transport (Errors).
IncidentsClient.create
JsonNode create(Object body, RequestOptions options)
Open an incident. Opens an incident in status open, adds the created entry to the timeline and forwards it to the SIEM. Needs tenant_admin, security_officer, developer or agent. An unknown severity answers 400 invalid_request. Writes the audit event incident.create. The answer (201) carries the incident with its timeline.
Route: /v1/incidents (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Title, severity, description, category, resources and assignee. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Open an incident".
Raises: the typed errors of the transport (Errors).
IncidentsClient.get
JsonNode get(String id)
Get an incident. Returns the incident with its timeline (kind, message, data, actor, date) and its containment actions (action, target, status, result). Open to any member of the tenant. Answers 404 not_found.
Route: /v1/incidents/{incident_id} (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the incident. |
Returns: JsonNode. Decoded JSON answer of the operation "Get an incident".
Raises: the typed errors of the transport (Errors).
IncidentsClient.list
Page<JsonNode> list()
List the incidents. Lists the incidents of the tenant, newest identifier first, paginated, optionally filtered by status and severity. Items do not carry the timeline nor the actions (read one incident for those). Open to any member of the tenant.
Route: /v1/incidents (GET).
This element takes no parameter.
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
IncidentsClient.list
Page<JsonNode> list(Map<String, ?> query)
List the incidents. Lists the incidents of the tenant, newest identifier first, paginated, optionally filtered by status and severity. Items do not carry the timeline nor the actions (read one incident for those). Open to any member of the tenant.
Route: /v1/incidents (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
IncidentsClient.receiveAlerts
JsonNode receiveAlerts(Object body)
Receive Alertmanager alerts. Webhook receiver of Prometheus Alertmanager (payload version 4). Each alert is keyed by its fingerprint:
Route: /v1/incidents/alerts (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Alertmanager webhook payload, at most 500 alerts. |
Returns: JsonNode. Decoded JSON answer of the operation "Receive Alertmanager alerts".
Raises: the typed errors of the transport (Errors).
IncidentsClient.receiveAlerts
JsonNode receiveAlerts(Object body, RequestOptions options)
Receive Alertmanager alerts. Webhook receiver of Prometheus Alertmanager (payload version 4). Each alert is keyed by its fingerprint:
Route: /v1/incidents/alerts (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Alertmanager webhook payload, at most 500 alerts. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Receive Alertmanager alerts".
Raises: the typed errors of the transport (Errors).
IncidentsClient.update
JsonNode update(String id, Object body)
Update an incident. Changes the status, severity or assignee and optionally adds a note. Each change is added to the timeline and forwarded to the SIEM; moving to resolved or closed sets resolved_at. Needs tenant_admin or security_officer. An unknown status or severity answers 400 invalid_request. Writes the audit event incident.update.
Route: /v1/incidents/{incident_id} (PATCH).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the incident. | |
body | Object | yes | Fields to change and an optional note. |
Returns: JsonNode. Decoded JSON answer of the operation "Update an incident".
Raises: the typed errors of the transport (Errors).
IncidentsClient.update
JsonNode update(String id, Object body, RequestOptions options)
Update an incident. Changes the status, severity or assignee and optionally adds a note. Each change is added to the timeline and forwarded to the SIEM; moving to resolved or closed sets resolved_at. Needs tenant_admin or security_officer. An unknown status or severity answers 400 invalid_request. Writes the audit event incident.update.
Route: /v1/incidents/{incident_id} (PATCH).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the incident. | |
body | Object | yes | Fields to change and an optional note. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Update an incident".
Raises: the typed errors of the transport (Errors).