Get the validity of a property

The /is_valid_property resource tells you whether a property is prohibited from setting. You can use the curl command to query the /is_valid_property endpoint:

1
curl -sX GET "http://localhost:8088/is_valid_property/propertyName" | jq '.'

If the property is not prohibited from setting, the endpoint should return true. Otherwise, the output should resemble:

1
2
3
4
5
{
  "@type": "generic_error",
  "error_code": 40000,
  "message": "One or more properties overrides set locally are prohibited by the KSQL server (use UNSET to reset their default value): [ksql.service.id]"
}
Last update: 2024-10-28