Instance

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/neo4j/main/json-schema/neo4j-instance-schema.json",
  "title": "Instance",
  "description": "An AuraDB cloud database 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/Instance",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the instance"
    },
    "name": {
      "type": "string",
      "description": "Display name of the instance"
    },
    "status": {
      "type": "string",
      "description": "Current status of the instance",
      "enum": [
        "creating",
        "running",
        "pausing",
        "paused",
        "resuming",
        "updating",
        "destroying",
        "destroyed",
        "loading",
        "restoring"
      ]
    },
    "tenant_id": {
      "type": "string",
      "description": "ID of the tenant this instance belongs to"
    },
    "cloud_provider": {
      "type": "string",
      "description": "Cloud provider hosting the instance",
      "enum": [
        "gcp",
        "aws",
        "azure"
      ]
    },
    "region": {
      "type": "string",
      "description": "Cloud region where the instance is deployed"
    },
    "type": {
      "type": "string",
      "description": "Instance type",
      "enum": [
        "enterprise-db",
        "enterprise-ds",
        "professional-db",
        "free-db"
      ]
    },
    "memory": {
      "type": "string",
      "description": "Memory allocated to the instance"
    },
    "storage": {
      "type": "string",
      "description": "Storage allocated to the instance"
    },
    "connection_url": {
      "type": "string",
      "description": "Bolt connection URI for the instance"
    },
    "metrics_integration_url": {
      "type": "string",
      "description": "URL for metrics integration endpoint"
    },
    "neo4j_version": {
      "type": "string",
      "description": "Neo4j database version running on the instance"
    }
  }
}