Skip to the content
Documentation

[RouteSettings]

No ratings yet

Available before Exponential 6: the legacy kernel had it before Exponential 6; the 4.x reference had no page for it.

Summary

The group [RouteSettings] of settings/rest.ini.

File

settings/rest.ini; override it in settings/override/rest.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
RouteSettingImpl ezpRestIniRouteFilter  
SkipFilter[] ezpRestErrorController_show; ezpRestAuthController_basicAuth; ezpRestAuthController_oauthRequired; ezpRestOauthTokenController_handleRequest Pattern for the skip filter SkipFilter[]=controller_action;version If the version component is not listed version "1" is assumed.
OptionalAuthentication[] expGraphQLRestController_query; expGraphQLRestController_subscribe Routes authenticated only when the request presents credentials (an Authorization header, or a token or key parameter); without any they run as the anonymous user (or [Authentication] DefaultUserID). controller_action. A request with a wrong or expired token is refused as on every other route, never run as anonymous.

See also

Generated example: rest.ini [RouteSettings]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/rest.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.