search

NREL / developer.nrel.gov

An issue tracker for NREL's APIs available at https://developer.nrel.gov
43 stars 39 forks source link

API health checks? #335

Closed spolloni closed 7 months ago

spolloni commented 8 months ago

Is there a health check for the NREL developer API or specifically the NSRDB endpoints? We are looking for a way to programmatically and periodically ping the API to ensure it is up and our credentials (email and key) are valid.

PjEdwards commented 8 months ago

@spolloni There is not a specific health check endpoint, however there are a couple you could use for the purpose. The simplest on is to hit https://developer.nrel.gov/api/nsrdb/?api_key=. This will return a very stripped down HTML page if everything is working. If you want to go one step further and hit an endpoint that does some work, the site count endpoint would be a good one to try.

RIAEvangelist commented 8 months ago

I'd be down to help with this @spolloni and @PjEdwards

Is there a current plan to work on it?

Seems like a simple enough tool to write.

spolloni commented 7 months ago

thank you @PjEdwards, that works!