Web Agents 2024.11

HTTP Return Code for JSON-Formatted Responses

An HTTP response code to return when a JSON-formatted error is triggered.

To prevent user agents displaying their default error pages, set to a non-error HTTP code, for example 202.

Example:

org.forgerock.agents.config.json.url[0]=http*://.example.com:/api/*

org.forgerock.agents.config.json.response.code=202

Performing a GET operation that matches the example triggers an HTTP result code 202 Accepted, and a JSON response containing 302 Found.

Default: Empty

Property name

org.forgerock.agents.config.json.response.code
  Introduced in Web Agent 4.x

Function

JSON-formatted response

Type

Integer

Bootstrap property

No

Required property

No

Restart required

No

AM console

Tab: Miscellaneous (From AM 7)

Title: HTTP Return Code for JSON-Formatted Responses

Copyright © 2010-2024 ForgeRock, all rights reserved.