Neon · Schema

EndpointCreateRequest

Request body for creating a new compute endpoint

DatabasesServerlessPostgresInfrastructureAuthenticationEdge

Properties

Name Type Description
endpoint object
View JSON Schema on GitHub

JSON Schema

neon-endpointcreaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EndpointCreateRequest",
  "title": "EndpointCreateRequest",
  "type": "object",
  "description": "Request body for creating a new compute endpoint",
  "properties": {
    "endpoint": {
      "type": "object",
      "required": [
        "branch_id",
        "type"
      ],
      "properties": {
        "branch_id": {
          "type": "string",
          "description": "The branch ID to attach the endpoint to"
        },
        "type": {
          "type": "string",
          "enum": [
            "read_write",
            "read_only"
          ],
          "description": "The endpoint type"
        },
        "autoscaling_limit_min_cu": {
          "type": "number",
          "description": "Minimum compute units for autoscaling"
        },
        "autoscaling_limit_max_cu": {
          "type": "number",
          "description": "Maximum compute units for autoscaling"
        },
        "suspend_timeout_seconds": {
          "type": "integer",
          "description": "Inactivity timeout in seconds"
        }
      }
    }
  }
}