Azure APIM behavior for undocumented parameters in swagger

Question

Hi Azure community,

Could you please help us to understand and document the behavior by Azure API Management in case of undocumented parameters in swagger exist in the request for the API call?

Does APIM block the request or pass it to backend by stripping off the undocumented parameters?

Kind Regards,

Salim

Answer 1

Hello Salim Demir (external),

Thanks for posting your question in the Microsoft Q&A forum.

Without any specific validation policy, APIM will pass all parameters to the backend, including undocumented ones.

You can use the validate-parameters policy to control how APIM handles undocumented parameters:

<validate-parameters 
    specified-parameter-action="ignore" 
    unspecified-parameter-action="prevent" 
    errors-variable-name="parameterValidationErrors" />

You can set the unspecified-parameter-action to one of these values:

• ignore: Allows undocumented parameters to pass through (default behavior).
• detect: Logs the presence of undocumented parameters but allows them.
• prevent: Blocks requests containing undocumented parameters.

---

Please don't forget to close up the thread here by upvoting and accept it as an answer if it is helpful