Skip to main content

Built-in Parameters

The following URL parameters have special meaning and can be passed in through the URL of the request:

GET ParameterDescription
&plainText=trueResponse will always be Content-Type: text/plain and the returned text will be human-readable (WriterSerializer.Builder.useWhitespace() enabled).
Useful for debugging.
&debug=trueEnable debug mode for request.
&noTrace=trueIf an error occurs, don't log the stack trace to the log file.
Useful for automated JUnit testcases testing error states to prevent the log file from filling up with useless stack traces.
&method=XOverload the HTTP method as a GET parameter (e.g "POST").
Must be enabled via @Rest(allowedMethodParams) setting.
&Header-Name=headerValueSpecify a header value as a GET parameter.
Must be enabled via @Rest(allowedHeaderParams) setting.
&body=XPass in the HTTP body content on PUT and POST methods as a UON-encoded GET parameter.
Can be disabled via @Rest(disableContentParam) setting.
&x-response-headers=XPass-through headers to the response.
Must be a UON-encoded map of key-value pairs.