GeroSense Developer Documentation
  • Getting Started
    • Main Concepts
    • Architecture Overview
    • Getting Authentication Credentials
  • GeroSense API Proxy Reference
    • Setting Up Docker Container
    • Checking API Status
    • Registering Users
    • Sending Users Data
    • Triggering biological age acceleration computations
    • Getting Users Biological Age Acceleration
      • Receiving results via a webhook
      • Receiving results via API polling
    • Getting Users Resilience
  • GeroSense API Reference
    • Requests Authentication
    • Registering Users
    • Sending Users Data
    • Triggering biological age acceleration computations
    • Getting Users Biological Age Acceleration
      • Receiving results via a webhook
      • Receiving results via API polling
    • Getting Users Resilience
Powered by GitBook
  1. GeroSense API Proxy Reference

Checking API Status

While we strive to keep our API without downtime, we might need a short maintenance window in some extremely rare cases. Additionally, we might deprecate some of the old API versions with time while some of your users still might be on the old version of your app. To help you handle these scenarios, we have /status endpoint. This is how to use it:

  • On your client application side, before sending any data to the API, request the /status endpoint.

  • Check if the status is Ok. If it's Maintenance, don't send any data to the API until it becomes Ok again.

  • In your client application, specify which API version it supports. If it's lower than minimal_api_version, ask your users to upgrade the app.

GET /api/status

REQUEST (EXAMPLE)
curl 'https://<api-proxy-hostname>/api/status'
200 – OK RESPONSE (EXAMPLE)
{
  "status": "Ok",
  "minimal_api_version":"v1.0"
}
200 – MAINTENANCE RESPONSE (EXAMPLE)
{
  "status": "Maintenance",
  "minimal_api_version":"v1.0"
}
PreviousSetting Up Docker ContainerNextRegistering Users

Last updated 1 year ago