CreateInstanceRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/neo4j/main/json-schema/neo4j-create-instance-request-schema.json",
  "title": "CreateInstanceRequest",
  "description": "Request body for creating a new AuraDB instance.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/neo4j-instances-api-openapi.yml#/components/schemas/CreateInstanceRequest",
  "type": "object",
  "required": [
    "name",
    "memory",
    "region",
    "cloud_provider",
    "type",
    "tenant_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the instance",
      "maxLength": 30
    },
    "version": {
      "type": "string",
      "description": "Neo4j version for the instance"
    },
    "region": {
      "type": "string",
      "description": "Cloud region where the instance should be deployed"
    },
    "memory": {
      "type": "string",
      "description": "Memory to allocate to the instance"
    },
    "type": {
      "type": "string",
      "description": "Instance type",
      "enum": [
        "enterprise-db",
        "enterprise-ds",
        "professional-db",
        "free-db"
      ]
    },
    "tenant_id": {
      "type": "string",
      "description": "ID of the tenant to create the instance in"
    },
    "cloud_provider": {
      "type": "string",
      "description": "Cloud provider for hosting",
      "enum": [
        "gcp",
        "aws",
        "azure"
      ]
    }
  }
}