Endpoints

Search endpoints

Semantic search across all detected endpoints and data handlers in an organization to find entry points that match a natural-language query. Endpoints include HTTP route handlers, WebSocket handlers, CLI argument parsers, file processors, and other data entry points detected during SAST scanning. Useful when investigating attack surface (e.g. "endpoints that handle file uploads", "unauthenticated API routes", "payment processing handlers"). Returns ranked results from the latest completed SAST scan of each repository, including HTTP path/methods when available.

post/api/v2/endpoints/search

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring

Organization to search within. Limits results to repositories the caller can access in this org.

querystring required

Natural-language search query matched against endpoint descriptions using semantic similarity (e.g. "user login endpoint", "payment processing handler", "file upload API").

limitinteger

Maximum number of results to return. Defaults to 10.

Response

Search results

idstring required

Unique ID of the endpoint handler.

repositoryIdstring required

ID of the repository containing this endpoint.

repositoryNamestring required

Display name of the repository.

applicationNamestring required

Name of the application this endpoint belongs to (e.g. "Payments API", "Auth Service").

namestring required

Handler function or route name.

descriptionstring required

Description of what this endpoint does.

authenticationstring nullable required

How this endpoint authenticates callers (e.g. "JWT bearer token", "API key"). Null if not detected.

authorizationstring nullable required

How this endpoint enforces access control (e.g. "admin role required"). Null if not detected.

httpPathstring nullable required

HTTP route path if this is an HTTP handler (e.g. "/api/users/:id"). Null for non-HTTP handlers.

httpMethodsstring[] nullable required

HTTP methods this handler responds to (e.g. ["GET", "POST"]). Null for non-HTTP handlers.

scorenumber required

Semantic similarity score between 0 and 1. Higher means a closer match to the query.

Changes

No recorded changes to this operation across all 1 revision of this API.