setup

Neon

Purpose

Collects Neon organizations, members, API key metadata, projects, branches, compute endpoints, databases, roles, and object storage buckets.

tip

Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into Subimage's managed vault. See Secrets for details.

Required Fields

Field Secret? Description
neon_api_key Yes Neon personal or organization API key

Optional Fields

Field Description
neon_org_ids Comma-separated organization IDs (org-...). Required with an organization API key. A personal key syncs all of its user's organizations by default.
neon_base_url Neon API URL. Defaults to https://console.neon.tech/api/v2.

Setup Steps

  1. In the Neon Console, create an API key. See Manage API keys.
    • An organization API key belongs to the organization rather than a person, so it keeps working when people leave. Create it with access to the whole organization, not a single project.
    • A personal API key sees every organization its user belongs to.
  2. In Subimage, enter the key in neon_api_key.
  3. With an organization API key, enter the organization's ID in neon_org_ids. It is in the Neon Console under Organization settings.
  4. Save the module and run a sync.

Notes

  • The sync only reads from the Neon API. It never reveals role passwords, API key tokens, or connection strings.
  • Members, API keys, roles, databases, and storage need the key and plan to allow reading them. When they cannot be read, the sync keeps what it stored earlier instead of deleting it.

Troubleshooting

  • Neon Unauthorized: the key is wrong or was revoked. Create a new one.
  • Neon Organization IDs Required: an organization API key cannot list organizations. Set neon_org_ids.
  • Neon Forbidden: the key cannot read the organization's projects. Use an organization key with access to every project, or a personal key.