..
    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.

.. _aodh-api:

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

   * - Configuration option = Default value
     - Description
   * - **[api]**
     -
   * - ``host`` = ``0.0.0.0``
     - (StrOpt) The listen IP for the aodh API server.
   * - ``paste_config`` = ``api_paste.ini``
     - (StrOpt) Configuration file for WSGI definition of API.
   * - ``pecan_debug`` = ``False``
     - (BoolOpt) Toggle Pecan Debug Middleware.
   * - ``port`` = ``8042``
     - (PortOpt) The port for the aodh API server.
   * - ``workers`` = ``1``
     - (IntOpt) Number of workers for aodh API server.
   * - **[oslo_middleware]**
     -
   * - ``max_request_body_size`` = ``114688``
     - (IntOpt) The maximum body size for each request, in bytes.
   * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
     - (StrOpt) 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.