APapinizer
ApiProxy

Update Error Handling Settings

Changed on

Updates Error Handling Settings for the specified API Proxy routing

patch/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/error-handling/

Request

Path parameters

projectNamestring required
apiProxyNamestring required

Request body

deployboolean

If true, deploy the API Proxy after saving changes

deployTargetEnvironmentNameListstring[]

List of environment names to deploy to (required when deploy=true)

errorHandlingType'DEFAULT' | 'ADVANCED' | 'STATUS_CODE_LIST'

Error handling strategy: DEFAULT, CUSTOM

statusCodeListinteger[]

List of HTTP status codes that trigger custom error handling

customizeErrorMessageEnabledboolean

Enable custom error messages for matching status codes

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • d1a546deccf0Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from object to string

    • breaking

      the / request property format changed from no format to int32

    This list may be incomplete.

  • 9ae232e55479Revision changes
    • info

      endpoint added