Skip to main content
The HackGATE REST API gives you programmatic access to your sites, projects, analytics, and account settings. All endpoints follow consistent conventions described on this page.

​
Base URL

https://api-admin.hackgate.io
All API endpoints are served under this base URL, at paths matching /api/[resource].

​
Request and response format

All requests and responses use JSON. Set the Content-Type header on requests that include a body: 
Content-Type: application/json

​
Authentication

Every request must include a valid Bearer token in the Authorization header: 
Authorization: Bearer <token>
Your token must carry an organization ID. Requests without a valid org context are rejected with 401. See Authentication for the two supported token types and how to obtain them.

​
Interactive explorer

You can explore and test all API endpoints interactively using the Swagger UI: https://api-admin.hackgate.io/swagger The explorer lets you authenticate with your token and send live requests directly from your browser.

​
HTTP status codes

StatusMeaning
200 OKRequest succeeded.
201 CreatedResource was created successfully.
400 Bad RequestInvalid input. The response body includes a title field with a description of the error.
401 UnauthorizedToken is missing, invalid, expired, or does not carry an org context.
404 Not FoundResource does not exist or belongs to a different organization.
500 Internal Server ErrorUnexpected server error.

​
Error response shape

Error responses include a title field with a human-readable message and a status field matching the HTTP status code: 
{
  "title": "Description of the error",
  "status": 400
}
Use the title field to diagnose validation errors and the status field to handle errors programmatically.

​
Explore the API

List sites

Retrieve all HackGATE sites in your organization.

List projects

Retrieve all projects in your organization.

Traffic analytics

Query traffic events and request timelines for your sites.

WAF analytics

Query Web Application Firewall events for your sites.

Account

Retrieve and manage your account details.

Billing

Access billing information for your organization.