/projects/{project_id}/advisorsalphaGet advisor issues
Analyzes the database for security and performance issues. Returns a list of issues categorized by severity (ERROR, WARN, INFO).
Requires read access to the project and Data API enabled.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/advisors" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.getProjectAdvisorSecurityIssues({ projectId: process.env.PROJECT_ID });Parameters
project_idNeon project ID
branch_idBranch ID to analyze. If not specified, the project's default branch is used.
database_nameDatabase name to analyze. Required if branch has multiple databases.
categoryFilter issues by category
min_severityMinimum severity level to include. For example, WARN returns WARN and ERROR issues, excluding INFO.
Response
200Successfully retrieved security advisor issues
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.