public-api-docs

Technical considerations

Rate Limiting

We are using AWS Web Application Firewall to protect our platform, against Denial-of-service attacks, by implementing rate limit rules.

Currently the rate limiting aggregation is based on Source IP address with a limit of 1.500 requests / 15 minutes.

AWS WAF rate limiting is designed to control high request rates and protect your application’s availability in the most efficient and effective way possible. It’s not intended for precise request-rate limiting.

Polling of resources

Most of our first-level entities like:

Health checks

We provide a health check endpoint for our services, which can be used to monitor the health of our services.

It is currently a work in progress to provide a more detailed health check in the future, which will include the health of the database and the health of other subsystems.

Following an example on how the health endpoint can be invoked:

production http { "method": "GET", "url": "/health/ping", "baseUrl": "https://go.api.gourban.services/v1", }