Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hackgate.io/llms.txt

Use this file to discover all available pages before exploring further.

HackGATE can track which of your API endpoints have been tested by cross-referencing recorded traffic against your OpenAPI specification. Upload your API schema once and HackGATE will show you a coverage report indicating how many requests each endpoint received during the testing period.

​
Upload your OpenAPI schema

Upload a JSON or YAML OpenAPI spec file (OpenAPI 3.x or Swagger 2.x): 
curl -X POST https://admin.hackgate.io/api/sites/uploadOpenAPISchema \
  -H "Authorization: Bearer <your-token>" \
  -F "siteId=<site-id>" \
  -F "file=@openapi.json"
Or with a YAML file: 
curl -X POST https://admin.hackgate.io/api/sites/uploadOpenAPISchema \
  -H "Authorization: Bearer <your-token>" \
  -F "siteId=<site-id>" \
  -F "file=@openapi.yaml"
Response: 
{
  "message": "File uploaded successfully",
  "fileName": "<site-id>.json",
  "url": "https://admin.hackgate.io/uploads/<site-id>.json"
}
Accepted file formats are .json, .yaml, and .yml. The file is validated against the OpenAPI specification before being stored.

​
Get API coverage report

Query coverage for a specific time range: 
curl "https://admin.hackgate.io/api/analytics/getAPICoverage?url=example-yourorg.hackgate.net&gte=2024-01-01T00:00:00Z&lte=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <your-token>"
Response: 
[
  { "path": "/api/users", "method": "GET", "count": 142 },
  { "path": "/api/users/{id}", "method": "PUT", "count": 0 },
  { "path": "/api/orders", "method": "POST", "count": 37 }
]
Endpoints with count: 0 have not been tested yet.

​
Retrieve the stored schema

curl https://admin.hackgate.io/api/sites/getAPIdefinition/<site-id> \
  -H "Authorization: Bearer <your-token>"
Returns the stored OpenAPI document as JSON, with the host set to your HackGATEd URL.
Focus retesting efforts on endpoints with count: 0 to improve coverage before closing an engagement.
Last modified on May 9, 2026