code-gov-api icon indicating copy to clipboard operation
code-gov-api copied to clipboard

Published 20 hours ago • verified publisher icon GSA

Create a new healthcheck endpoint

Open froi opened this issue 5 years ago • 1 comments

We are currently using the root of the API (/api) as an informative and healthcheck endpoint for our API. This endpoint can only be accessed using an API key. We want to create a separate healthcheck endpoint and leave the /api endpoint for informative uses.

Describe the solution you'd like

  • Create a /healthcheck endpoint with API status information
  • Modify the /api endpoint to display only informative data about the API. Eg. where are the developer docs, where are the swagger docs, the running API version. etc.

froi avatar Jul 24 '18 20:07 froi

api endpoint no longer implemented in current version (v2.6.1).

Nosferican avatar Oct 18 '19 00:10 Nosferican