ApiProxy

Update Custom Message Settings

Changed on

Updates Custom Message Builder Settings for the specified API Proxy routing

patch/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/custom-message/

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)

buildCustomMessageboolean

Enable custom response message building

customMessageTemplatestring

Custom response message template (supports variables)

customMessageContentTypestring

Content type of the custom response (e.g. application/json, application/xml)

customMessageHttpStatusCodeinteger

HTTP status code for the custom response

Response

successful operation!

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

Changes