Logs
- Last UpdatedJul 18, 2024
- 2 minute read
APIs related to querying log data
Get Tenant Logs
Returns logs for a tenant. The source parameter can be repeated multiple times. Valid sources are Account Management and Identity Management. Omit the source parameter to retrieve all sources. The severity parameter can be repeated multiple times. Valid severities are: - Critical - Error - Warning - Information - Verbose Omit the severity parameter to retrieve all severities.
Request
GET /api/v1/tenants/{tenantId}/logs
?start={start}&end={end}&source={source}&severity={severity}&skip={skip}&count={count}
Parameters
string tenantId
Tenant identifier
[optional] string start
Start timestamp of tenant logs[optional] string end
End timestamp of tenant logs[optional] array source
One or more valid sources to filter tenant logs[optional] array severity
One or more severities to filter tenant logs[optional] integer skip
Number of logs to skip[optional] integer count
Maximum number of logs to return
Enumerated Values
| Parameter | Value |
|---|---|
| severity | 0 |
| severity | 1 |
| severity | 2 |
| severity | 3 |
| severity | 4 |
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Customer facing logs for provided tenant Id |
| 400 | None | Missing or invalid inputs |
| 401 | None | Unauthorized |
| 403 | None | Forbidden |
| 500 | None | Internal server error |
Get Namespace Logs
Returns logs for a namespace. The source parameter can be repeated multiple times. Valid sources are: - Data ingress - Data storage - Data views - Metadata - PI to CONNECT Omit the source parameter to retrieve all sources. The severity parameter can be repeated multiple times. Valid severities are: - Critical - Error - Warning - Information - Verbose Omit the severity parameter to retrieve all severities.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/logs
?start={start}&end={end}&source={source}&severity={severity}&skip={skip}&count={count}
Parameters
string tenantId
Tenant identifierstring namespaceId
Namespace identifier
[optional] string start
Start timestamp of namespace logs[optional] string end
End timestamp of namespace logs[optional] array source
One or more sources to filter namespace logs[optional] array severity
One or more severities to filter namespace logs[optional] integer skip
Number of logs to skip[optional] integer count
Maximum number of logs to return
Enumerated Values
| Parameter | Value |
|---|---|
| severity | 0 |
| severity | 1 |
| severity | 2 |
| severity | 3 |
| severity | 4 |
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Customer facing logs for provided namespace Id. |
| 400 | None | Missing or invalid inputs |
| 401 | None | Unauthorized |
| 403 | None | Forbidden |
| 500 | None | Internal server error |
Definitions
SeverityLevel
Object describing the Severity Level of customer logs.
Enumerated Values
| Property | Value |
|---|---|
| Verbose | 0 |
| Information | 1 |
| Warning | 2 |
| Error | 3 |
| Critical | 4 |