Validate batch configuration
POST /apisix/admin/configs/validate
POST /apisix/admin/configs/validateInteractive request editor loads with JavaScript.
X-API-KEY<token>
In: header
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "$API_BASE_URL/apisix/admin/configs/validate" \ -H "Content-Type: application/json" \ -d '{}'Operation completed successfully with no response body.
""Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
{
"value": {},
"error_msg": "error message"
}Complete operation details and schema variants
POST /apisix/admin/configs/validate
Validate batch configuration
Validate a batch of APISIX declarative configurations including routes, services, consumers, upstreams, etc. Performs resource-level JSON Schema validation, plugin check_schema advanced validation, and duplicate ID detection. Returns all validation errors at once.
Parameters
Request body
Content type: application/json
routes(array, optional):services(array, optional):consumers(array, optional):upstreams(array, optional):ssls(array, optional):global_rules(array, optional):stream_routes(array, optional):plugin_metadata(array, optional):plugin_configs(array, optional):consumer_groups(array, optional):
Responses
200: Operation completed successfully with no response body.400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.value(object, optional): The specific resource.error_msg(string, optional): The error message.
cURL
curl -X POST '$API_BASE_URL/apisix/admin/configs/validate'