Neon · Schema

ConnectionUri

A database connection URI

DatabasesServerlessPostgresInfrastructureAuthenticationEdge

Properties

Name Type Description
connection_uri string The full connection URI including host, database, role, and password
connection_parameters object Individual connection parameters
View JSON Schema on GitHub

JSON Schema

neon-connectionuri-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionUri",
  "title": "ConnectionUri",
  "type": "object",
  "description": "A database connection URI",
  "properties": {
    "connection_uri": {
      "type": "string",
      "description": "The full connection URI including host, database, role, and password"
    },
    "connection_parameters": {
      "type": "object",
      "description": "Individual connection parameters",
      "properties": {
        "database": {
          "type": "string",
          "description": "The database name"
        },
        "host": {
          "type": "string",
          "description": "The hostname"
        },
        "password": {
          "type": "string",
          "description": "The password"
        },
        "role": {
          "type": "string",
          "description": "The role name"
        }
      }
    }
  }
}