Get advisor issues

GET /projects/{project_id}/advisorsalpha

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.

Markdown for AI context

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.

Also available in

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getProjectAdvisorSecurityIssues({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID
  }
});

Project ID

project_id

string

Neon project ID

Branch ID

branch_id

string

Branch ID to analyze. If not specified, the project's default branch is used.

Database name

database_name

string

Database name to analyze. Required if branch has multiple databases.

Category

category

string

Filter issues by category

Min severity

min_severity

string

Minimum severity level to include. For example, WARN returns WARN and ERROR issues, excluding INFO.

200

Successfully retrieved security advisor issues

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.