Skip to main content
Version: 67.0.0

a9s Public API

This section describes the a9s Public API configuration.

The a9s Data Service Framework comes with a Public API that is available for the Application Developer to execute requests using HTTPS calls.

The API can be used to access and manipulate the following resources:

  • Instance Backups
  • Instance Backup Configs
  • Instance Disaster Recovery
  • Instance Metrics
  • Instance Point-in-Time Recovery (PITR)
  • Instance Restores
  • Instance Settings

The a9s Public API also serves as the supporting backend for the a9s Service Dashboard.

Single Sign-On

The a9s Public API provides a Single Sign-On functionality, whereby only an authenticated and authorized user with the SpaceDeveloper role can access the a9s Public API. It verifies the authorization of the user accessing the a9s Public API by asking Cloud Foundry for the user's permission to access the Service Instance.

To update the service instances, the user must have the permission 'manage' for the Cloud Foundry API endpoint GET /v2/service_instances/:guid/permissions. For more information, see Retrieving permissions on a Service Instance.

The a9s Public API verifies the token expiration time and automatically obtains a new access token if a refresh token is provided.