==================
REST API Reference
==================

.. Please keep this list alphabetical

.. note::
    Based on the |RBAC| policy, for every API listed below except for |PTP|
    Status Notifications, the execution of ``GET`` requests requires a reader
    role in either admin or services project; for ``non-GET`` requests (DELETE,
    PATCH, POST and PUT), an admin role in either admin or services project is
    required.

StarlingX project REST API references:

* `Bare Metal </api-ref/metal/index.html>`__
* `Configuration </api-ref/config/index.html>`__
* `Distributed Cloud </api-ref/distcloud/index.html>`__
* `Fault Management </api-ref/fault/index.html>`__
* `High Availability </api-ref/ha/index.html>`__
* `NFV </api-ref/nfv/index.html>`__
* `Node Interface Metrics Exporter </api-ref/app-node-interface-metrics-exporter/index.html>`__
* `PTP Status Notifications </api-ref/ptp-notification-armada-app/index.html>`__
* `Software Updates </api-ref/update/index.html>`__