6.1. Endpoints

The primary API is the server programs’ control sockets. There is also a monitoring interface available which provides for OpenMetrics and health check endpoints. There is also a HTTP/JSON endpoint that can be installed which sometimes cam be more convenient. The API calls, and their respective request and response bodies are documented in the API reference.

• 6.1.1. Monitor
  • 6.1.1.1. Endpoints
    • 6.1.1.1.1. /metrics
    • 6.1.1.1.2. /ready
    • 6.1.1.1.3. /healthy
• 6.1.2. Control sockets
• 6.1.3. HTTP/JSON
  • 6.1.3.1. Installation
    • 6.1.3.1.1. Distributions
      • 6.1.3.1.1.1. Ubuntu
      • 6.1.3.1.1.2. RHEL
    • 6.1.3.1.2. Startup
  • 6.1.3.2. Upgrade
  • 6.1.3.3. Configuration
    • 6.1.3.3.1. Authentication directives
    • 6.1.3.3.2. Listener directives
    • 6.1.3.3.3. Other directives
    • 6.1.3.3.4. Environment directives
  • 6.1.3.4. Examples