Skip to main content
Version: 1.17

Administration endpoints

The administration API in ADS is used for retrieving information, allowing clients to request data or query the status of the service. Its respective RESTful API endpoints are essential for operations that require accessing specific information without modifying the service's state or data.

The administration API endpoints use the GET method for retrieving information, allowing clients to request data or query the status of the service.

More specifically, the administration endpoints are used for the following operations:

  • Healthcheck
  • Metrics
  • System information

The following table offers a structured overview of the GET endpoints available in ADS, as well as their functionalities:

EndpointFunctionDescription
GET /healthcheckHealthcheckVerifies the application's state, displays domain identifiers, and reports on reconfiguration attempts.
The healthcheck endpoint provides the following probes:
- /liveness
- /startup
- /readiness
You can find more information on these probes the next section.
GET /admin/metrics/prometheusMetricsGathers service performance data.
GET /admin/system/infoSystem InformationProvides detailed system information useful for troubleshooting and support.