#063Technical3 min

Analyze an API with Hackaiz

Verify the API domain, examine reachable routes and understand what the analysis covers.

Hackaiz team · updated 21/11/2026

Illustration: an engineer works next to servers.
Illustration: an engineer works next to servers. Illustrative photo, not a screenshot.

01Identify the deployed API boundary

An API is an interface that software calls to read data or perform actions. Its address may be different from the address of your application: a page on app.example.com can call api.example.com. Start by identifying the deployed domain that receives those requests. A check of the marketing website alone does not establish how the API handles private records or administrative operations.

Hackaiz includes API-related probes within its authorized website analysis, including a check of routes discovered through an OpenAPI or Swagger description. This is not a promise to exercise every API operation. Separate the deployed endpoint, its source repository and its database in your preparation so that each result has a clear scope.

02Provide ownership proof before any analysis

Open /connect and enter the intended target. Analysis of a website or API requires domain ownership proof first. You can add the displayed DNS TXT value under _hackaiz, publish it in /.well-known/hackaiz-verification.txt over HTTPS, or ask the AI editing your project to create that file using Hackaiz's instruction. Verification belongs to the domain shown in the interface.

Coordinate with the domain administrator if you cannot change DNS or publish the file. Having an API URL or its public documentation is not permission to analyze it. Keep separate notes for development and production endpoints, and do not assume that proving control of your front-end domain proves a different API hostname. Prepare the proof before scheduling the inspection.

03Understand how API routes are selected

The API authentication probe looks for an OpenAPI or Swagger description at known documentation paths. It parses that description and selects eligible GET operations, which are requests intended to read information. The probe excludes routes with path parameters and operations requiring other mandatory parameters, and it does not report an operation explicitly declared public as missing authentication.

The probe makes bounded anonymous requests and looks for a successful response containing structured JSON data. A site's fallback HTML page is not accepted as evidence of an API response. If no usable specification is found or the operations are outside this probe's selection, that does not demonstrate that the API is secure; it means this particular source of route evidence is absent or limited.

04Read a response as evidence, not a complete verdict

A finding can show an anonymous GET, the route, the response status and a masked excerpt. Ask the API owner whether the returned information should be public. An endpoint listing public product categories has a different intended audience from one returning customer invoices. Route names suggesting administration or private records help prioritize review, but intended access still needs confirmation.

An anonymous response does not by itself prove every form of cross-user access. Authentication asks who is calling; authorization asks whether that caller may access this record or perform this action. Review the API's server-side checks and, when relevant, connect its repository or database separately to investigate the implementation rather than treating one external request as complete coverage.

05Choose and verify the next action

Selected API and website analyses use credits. Checks left unticked are neither run nor billed, so record the checks actually performed with any conclusions you share. Findings are presented as Danger, To fix and To watch. Review the affected route and evidence, then assign the change to the person responsible for the API's authentication or access-control layer.

If the correction is proposed through GitHub, it is a draft pull request for human review and approval, never an automatic merge. After the reviewed change is deployed, repeat the relevant authorized analysis and confirm that intentionally public responses still work. A later check uses credits too; give it the specific goal of verifying the reported route and note any operations that remain outside the inspection.

Frequently asked questions

Was this article helpful?

Related articles