a9s Public API
This section describes the a9s Public API and a9s Service Dashboard configuration.
The a9s Data Service Framework comes with a a9s Service Dashboard where it is possible to trigger backups, restores, configure updates, restart and recreate the Service Instance, as well as visualize its metrics.
It also exposes an API that is available for the Application Developer to execute requests using HTTP calls.
This component also provides single sign-on, where only an authenticated and authorized user with the SpaceDeveloper
role can access the a9s Service Dashboard and its API. It verifies the authorization of the user accessing the a9s
Service Dashboard by asking Cloud Foundry for the user's permission to access the Service Instance. The user must have
the permission 'manage' for the Cloud Foundry API endpoint GET /v2/service_instances/:guid/permissions, see the
documentation Retrieving permissions on a Service Instance.
The a9s Public API verifies the token expiration time and tries to refresh the token if a refresh token exists.
The a9s Service Dashboard needs to be deployed on a VM with at least 2 GB of RAM.
📄️ Customize Maintenance Updates Modal
If the Platform Operator decides to allow the Application Developers to manage the Maintenance Updates,
📄️ Customize Color Theme
Customize the Color Theme of the Service Dashboard
📄️ a9s Public API Properties
This section describes the supported properties of the a9s Public API component.
📄️ Static Navigation Entries
The a9s Service Dashboard can show additional navigation entries in its navbar. These can point to defined targets and
📄️ Support Mail Address
The a9s Service Dashboard displays a support email address to users when an error page ('4xx' or '5xx') appears. This