Skip to content
Management API Reference

Gets project security advisors.
deprecated

get/v1/projects/{ref}/advisors/security

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • advisors_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • lint_type
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "lints": [
    {
      "name": "unindexed_foreign_keys",
      "title": "lorem",
      "level": "ERROR",
      "facing": "EXTERNAL",
      "categories": [
        "PERFORMANCE"
      ],
      "description": "lorem",
      "detail": "lorem",
      "remediation": "lorem",
      "metadata": {
        "schema": "lorem",
        "name": "lorem",
        "entity": "lorem",
        "type": "table",
        "fkey_name": "lorem",
        "fkey_columns": [
          42
        ]
      },
      "cache_key": "lorem"
    }
  ]
}