v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB
Project

Get 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.

get/projects/{project_id}/advisors

Query parameters

branch_idstring

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

database_namestring

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

category'SECURITY' | 'PERFORMANCE'

Category of an advisor issue

Filter issues by category

min_severity'INFO' | 'WARN' | 'ERROR'

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

Response

Successfully retrieved security advisor issues

Example response

{
  "issues": [
    {
      "name": "rls_disabled_in_public",
      "title": "RLS Disabled in Public",
      "level": "ERROR",
      "facing": "EXTERNAL",
      "categories": [
        "SECURITY"
      ],
      "detail": "Table `public.users` is public, but RLS has not been enabled.",
      "remediation": "https://neon.com/docs/data-api/database-advisor"
    }
  ]
}