..
    Warning: Do not edit this file. It is automatically generated from the
    software project's code and your changes will be overwritten.

    The tool to generate this file lives in openstack-doc-tools repository.

    Please make any changes needed in the code, then run the
    autogenerate-config-doc tool from the openstack-doc-tools repository, or
    ask for help on the documentation mailing list, IRC channel or meeting.

.. _neutron-api:

.. list-table:: Description of API configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[DEFAULT]**
     -
   * - ``allow_bulk`` = ``True``
     - (Boolean) Allow the usage of the bulk API
   * - ``allow_pagination`` = ``False``
     - (Boolean) Allow the usage of the pagination
   * - ``allow_sorting`` = ``False``
     - (Boolean) Allow the usage of the sorting
   * - ``api_extensions_path`` =
     - (String) The path for API extensions. Note that this can be a colon-separated list of paths. For example: api_extensions_path = extensions:/path/to/more/exts:/even/more/exts. The __path__ of neutron.extensions is appended to this, so if your extensions are in there you don't need to specify them here.
   * - ``api_paste_config`` = ``api-paste.ini``
     - (String) File name for the paste.deploy config for api service
   * - ``backlog`` = ``4096``
     - (Integer) Number of backlog requests to configure the socket with
   * - ``client_socket_timeout`` = ``900``
     - (Integer) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
   * - ``max_header_line`` = ``16384``
     - (Integer) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).
   * - ``pagination_max_limit`` = ``-1``
     - (String) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit
   * - ``retry_until_window`` = ``30``
     - (Integer) Number of seconds to keep retrying to listen
   * - ``service_plugins`` =
     - (List) The service plugins Neutron will use
   * - ``tcp_keepidle`` = ``600``
     - (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
   * - ``use_ssl`` = ``False``
     - (Boolean) Enable SSL on the API server
   * - ``wsgi_default_pool_size`` = ``100``
     - (Integer) Size of the pool of greenthreads used by wsgi
   * - ``wsgi_keep_alive`` = ``True``
     - (Boolean) If False, closes the client socket connection explicitly.
   * - ``wsgi_log_format`` = ``%(client_ip)s "%(request_line)s" status: %(status_code)s  len: %(body_length)s time: %(wall_seconds).7f``
     - (String) A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
   * - **[oslo_middleware]**
     -
   * - ``max_request_body_size`` = ``114688``
     - (Integer) The maximum body size for each request, in bytes.
   * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
     - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
   * - **[oslo_versionedobjects]**
     -
   * - ``fatal_exception_format_errors`` = ``False``
     - (Boolean) Make exception message format errors fatal