Skip to main content
API coverage lets you measure how thoroughly researchers have tested your API. Upload your OpenAPI schema to a HackGATE site, then query the coverage endpoint to see which defined paths and methods have been hit — and which have not.
1

Upload your OpenAPI schema

Upload a valid OpenAPI 2.x or 3.x document to your HackGATE site using multipart form data. Replace SITE_ID with the ID of your site.
Accepted file formats: .json, .yaml, .ymlOn success, the response includes the stored file name and URL:
The uploaded schema must be a valid OpenAPI 2.x or 3.x document. Invalid documents return a 400 with validation errors.
2

Query API coverage

After researchers have been testing your site, query the coverage endpoint to see how many times each defined endpoint was hit.
The response is an array of objects, one per defined route:
A count of 0 means the endpoint was not tested during the selected period.
3

Retrieve the schema with your site ID

Fetch the stored schema at any time. HackGATE returns the original document with the SITE_ID field, so researchers can import it directly into their tools.
Share this endpoint with researchers so they can import your API definition directly into Burp Suite, Postman, or other testing tools.