..
    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]**
     -
   * - ``alarm_max_actions`` = ``-1``
     - (Integer) Maximum count of actions for each state of an alarm, non-positive number means no limit.
   * - ``enable_combination_alarms`` = ``False``
     - (Boolean) DEPRECATED: Enable deprecated combination alarms. Combination alarms are deprecated. This option and combination alarms will be removed in Aodh 5.0.
   * - ``paste_config`` = ``api_paste.ini``
     - (String) Configuration file for WSGI definition of API.
   * - ``pecan_debug`` = ``False``
     - (Boolean) Toggle Pecan Debug Middleware.
   * - ``project_alarm_quota`` = ``None``
     - (Integer) Maximum number of alarms defined for a project.
   * - ``user_alarm_quota`` = ``None``
     - (Integer) Maximum number of alarms defined for a user.
   * - ``workers`` = ``1``
     - (Integer) Number of workers for aodh API server.
   * - **[oslo_middleware]**
     -
   * - ``enable_proxy_headers_parsing`` = ``False``
     - (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
   * - ``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 a SSL termination proxy.