Accept-Verbosity header
- Last UpdatedSep 04, 2025
- 2 minute read
When the DebugMode configuration is set to false, sanitized error messages are returned and you have no control over what information is included in the response. Using the Accept-Verbosity header allows you to specify additional information in the response, regardless of the server-side configuration.
When the PI Web API processes an OMF request with the Accept-Verbosity header, the returned response can include information
Note: We recommend against using the Accept-Verbosity header on request because it can return additional information such as values supplied by the client, the internal state of the PI System, or other information determined at runtime. This data is not included in responses by default due to the security risk it can pose to insecure systems, such as reflected XSS attacks or information disclosure attacks.
However, if the design of your application requires the use of the Accept-Verbosity header, you must be aware of the risks and ensure that the information is handled correctly and securely (e.g., by escaping returned strings before presenting them to the user or by preventing deserialization of the response from requesting external resources ).
The Accept-Verbosity header can be used with the following values:
|
Header value |
Additional details returned |
Description |
|---|---|---|
|
parameters |
Parameters associated with log events |
Events may include parameters that help contextualize the event. For example, if an event says a TYPE was not found, it may include a parameter indicating the ID of the missing TYPE. |
|
exceptions |
Exception information associated with a log event |
Events may arise because of an exception occurring during processing. If an event has such an exception associated with it, it will include information about the exception that occurred.. |
|
inner events |
Inner log events contained within a parent log event |
Events may include inner events that help contextualize the event. For example, if an event says there's a conflict with an existing PI Point, the inner events may contain information describing the reason the conflict occurred.. |
|
verbose |
Behaves the same as specifying both parameters and inner events |
Multiple Accept-Verbosity header and/or values can be sent within the same request. For example, a client could indicate that the response should include event parameters and exceptions in either of the following ways:
-
Accept-Verbosity header specified multiple times:
-
Accept-Verbosity: parameters
-
Accept-Verbosity: exceptions
-
-
Accept-Verbosity header specified once, with multiple values:
-
Accept-Verbosity: parameters, exceptions
-