rest.ini [RouteSettings] #

The block [RouteSettings] of settings/rest.ini, with 3 setting(s).

Never edit settings/rest.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/rest.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/rest.ini.append.php for one siteaccess,
• extension/<extension>/settings/rest.ini.append.php in an extension (read when the extension is active).

RouteSettingImpl #

Default: ezpRestIniRouteFilter.

<?php /* #?ini charset="utf-8"?
# settings/override/rest.ini.append.php
[RouteSettings]
RouteSettingImpl=ezpRestIniRouteFilter
*/ ?>

SkipFilter #

Pattern for the skip filter
SkipFilter[]=controller_action;version
If the version component is not listed version "1" is assumed.

Default: a list of 4: ezpRestErrorController_show, ezpRestAuthController_basicAuth, ezpRestAuthController_oauthRequired, ezpRestOauthTokenController_handleRequest.

<?php /* #?ini charset="utf-8"?
# settings/override/rest.ini.append.php
[RouteSettings]
# an empty "SkipFilter[]" first replaces the shipped list; without it the items are added
SkipFilter[]
SkipFilter[]=ezpRestErrorController_show
SkipFilter[]=ezpRestAuthController_basicAuth
SkipFilter[]=ezpRestAuthController_oauthRequired
SkipFilter[]=ezpRestOauthTokenController_handleRequest
*/ ?>

OptionalAuthentication #

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.

Default: a list of 2: expGraphQLRestController_query, expGraphQLRestController_subscribe.

<?php /* #?ini charset="utf-8"?
# settings/override/rest.ini.append.php
[RouteSettings]
# an empty "OptionalAuthentication[]" first replaces the shipped list; without it the items are added
OptionalAuthentication[]
OptionalAuthentication[]=expGraphQLRestController_query
OptionalAuthentication[]=expGraphQLRestController_subscribe
*/ ?>

Related #

• All blocks of rest.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/rest.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.