API monitoring
The following tables can help you monitor API activity. This may be useful in case you want to have a general overview of how APIs are being used, what are the results obtained, or spot potential errors.
secops.audit.api
In this table, you can find detailed information about the activity registered by the different APIs that work with alerts, such as the Delivery methods API (used for the creation and management of sending policies and delivery methods) or the Alerts API (used for the creation and management of alerts).
Field | Data type | Description |
---|---|---|
hostname |
| The machine (pod) that processes the performed request and answers accordingly. |
service |
| The name of the service:
|
method |
| The method used for the request.
|
url |
| The complete URL of the request. |
baseUri |
| The part of the URL without the relativePath. It consist of the general path to access the resource. |
relativePath |
| The part of the URL without the baseUri. It consists of the specific path to access the specific service. |
body |
| The complete body that is sent with the request and describes its content. |
username |
| The user making the request. |
headers |
| The list of headers within the request. |
msgType |
| Type of request.
|
status |
| The code that indicates how the request was responded (only for the Response type in msgType). |
cid |
| The ID of the request for traceability purposes. |
responseTimeMillis |
| The milliseconds it took the request to be processed. |
Â