Get advisor issues

GET/projects/{project_id}/advisorsGet 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.

Parameters

project_idstringpathrequired

Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringquery

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

pattern ^[a-z0-9-]{1,60}$

database_namestringquery

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

categorystringquery

Filter issues by category

one of "SECURITY", "PERFORMANCE"

min_severitystringquery

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

one of "INFO", "WARN", "ERROR"

Responses

object

issuesarray of objectrequired

Show child attributes

Show array items

cache_keystringrequired

Unique key for caching this issue result

categoriesarray of stringrequired

Categories this issue belongs to

Show child attributes

descriptionstringrequired

Detailed description of what this check detects

detailstringrequired

Specific details about this instance of the issue

facingstringrequired

Whether this issue affects external API exposure or is internal only

one of "EXTERNAL", "INTERNAL"

levelstringrequired

Severity level of the issue

metadataobjectrequired

Additional context-specific metadata

namestringrequired

Unique identifier for the issue type

remediationstringrequired

URL to documentation on how to fix this issue

titlestringrequired

Human-readable title

Example response

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

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idquery parameter

database_namequery parameter

categoryquery parameter

min_severityquery parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/advisors?branch_id=string&category=PERFORMANCE&database_name=string&min_severity=ERROR");
using var response = await client.SendAsync(request);

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

{
  "code": "",
  "message": "string",
  "request_id": "string"
}