{ "components": { "schemas": { "ActivityLog": { "description": "Activity log", "properties": { "action_id": { "description": "The action ID", "type": "string" }, "action_name": { "description": "A human readable name for the activity", "type": "string" }, "description": { "description": "The description of the activity", "type": "string" }, "email": { "description": "The user's email", "type": "string" }, "id": { "description": "Activity log ID", "type": "string" }, "ip_address": { "description": "The user IP address", "type": "string" }, "logged_at": { "description": "The time when the activity happened", "format": "date-time", "type": "string" }, "org_id": { "description": "The organization ID the activity belongs to", "type": "string" }, "payload": { "description": "The payload for the activity with detailed information", "type": "string" }, "project_id": { "description": "The project ID the activity belongs to", "type": "string" }, "project_name": { "description": "The project name the activity belongs to", "type": "string" }, "status": { "description": "The activity status", "type": "string" }, "timestamp": { "description": "The timestamp for when the activity was stored in the system", "type": "integer" }, "user_id": { "description": "The user responsible of the activity", "type": "string" } }, "type": "object" }, "AgentDetails": { "description": "Detailed information about an Aura Agent.", "properties": { "created_by": { "description": "The user who created the agent", "readOnly": true, "type": "string" }, "dbid": { "description": "The ID of the database instance", "type": "string" }, "description": { "description": "A description of the agent", "type": "string" }, "enabled": { "description": "Whether the agent is enabled", "type": "boolean" }, "id": { "description": "The unique identifier of the agent", "format": "uuid", "type": "string" }, "is_mcp_enabled": { "description": "Whether MCP is enabled", "type": "boolean" }, "is_private": { "description": "Whether the agent is private", "type": "boolean" }, "name": { "description": "The name of the agent", "type": "string" }, "organization_id": { "description": "The organization ID the agent belongs to", "format": "uuid", "readOnly": true, "type": "string" }, "project_id": { "description": "The project ID the agent belongs to", "format": "uuid", "readOnly": true, "type": "string" }, "system_prompt": { "description": "The system prompt for the agent", "type": "string" }, "tools": { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array" } }, "required": [ "id", "name", "description", "dbid", "is_private", "tools" ], "type": "object" }, "AgentSummary": { "description": "Summary information for an agent returned when listing agents.", "properties": { "dbid": { "description": "The ID of the database instance", "type": "string" }, "description": { "description": "A description of the agent", "type": "string" }, "enabled": { "description": "Whether the agent is enabled", "type": "boolean" }, "endpoint_link": { "description": "The public endpoint link for the agent", "format": "uri", "type": "string" }, "id": { "description": "The unique identifier of the agent", "format": "uuid", "type": "string" }, "is_mcp_enabled": { "description": "Whether MCP is enabled", "type": "boolean" }, "is_private": { "description": "Whether the agent is private", "type": "boolean" }, "mcp_endpoint_link": { "description": "The MCP endpoint link for the agent", "format": "uri", "type": "string" }, "name": { "description": "The name of the agent", "type": "string" }, "organization_id": { "description": "The organization ID the agent belongs to", "format": "uuid", "type": "string" }, "project_id": { "description": "The project ID the agent belongs to", "format": "uuid", "type": "string" }, "tools": { "description": "A summary of the tools attached to the agent.", "items": { "properties": { "name": { "description": "The name of the tool", "type": "string" }, "type": { "description": "The type of the tool", "enum": [ "text2cypher", "cypherTemplate", "similaritySearch" ], "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" } }, "required": [ "id", "name", "description", "dbid", "is_private", "tools" ], "type": "object" }, "BillingErrorItem": { "description": "A single error entry returned by billing endpoints.", "properties": { "error": { "description": "Error code or category identifier.", "type": "string" }, "message": { "description": "Human-readable description of the error.", "type": "string" } }, "required": [ "error", "message" ], "type": "object" }, "BillingErrorResponse": { "description": "Error body returned for HTTP 400 responses.", "properties": { "errors": { "items": { "$ref": "#/components/schemas/BillingErrorItem" }, "type": "array" } }, "required": [ "errors" ], "type": "object" }, "CreateDatabaseBackupResponse": { "description": "The response returned when a Backup has been scheduled", "properties": { "id": { "description": "The ID of the scheduled Backup, used to poll its status", "type": "string" } }, "required": [ "id" ], "type": "object" }, "CreateInstanceResponse": { "description": "Response returned when creating an Instance.", "properties": { "cloud_provider": { "description": "The cloud provider hosting the Instance", "enum": [ "gcp", "aws", "azure" ], "type": "string" }, "connection_url": { "description": "The URL to connect to the Neo4j Instance with", "type": "string" }, "created_at": { "description": "The timestamp when the Instance was created", "format": "date-time", "type": "string" }, "default_database_id": { "description": "The ID of the default database", "nullable": true, "type": "string" }, "id": { "description": "The Instance ID", "type": "string" }, "legacy_status": { "description": "The status of the Instance", "enum": [ "creating", "pausing", "suspending", "loading", "restoring", "updating", "overwriting", "resuming", "destroying", "resizing", "loading failed", "running", "paused", "suspended", "encryption key deleted", "encryption key error", "encryption key not found", "upgrading" ], "type": "string" }, "memory": { "description": "The size of the Instance memory", "nullable": true, "type": "string" }, "multi_database": { "description": "Whether multi-database is enabled", "type": "boolean" }, "name": { "description": "The name of the Instance", "type": "string" }, "password": { "description": "The initial password for authenticating with this Instance", "type": "string" }, "project_id": { "description": "The project ID the Instance belongs to", "type": "string" }, "region": { "description": "The region where the Instance is hosted", "type": "string" }, "storage": { "description": "The size of the Instance storage", "nullable": true, "type": "string" }, "type": { "description": "The type of the Instance", "enum": [ "enterprise-db", "enterprise-ds", "business-critical", "professional-db", "professional-ds", "free-db" ], "type": "string" }, "username": { "description": "The initial username for authenticating with this Instance", "type": "string" }, "vector_optimized": { "description": "Whether the Instance is vector optimized", "type": "boolean" } }, "required": [ "id", "name", "project_id", "connection_url", "username", "password", "cloud_provider", "region", "type", "created_at", "vector_optimized", "multi_database", "legacy_status" ], "type": "object" }, "CypherParameterConfig": { "description": "A parameter definition for a Cypher template.", "properties": { "data_type": { "description": "The data type of the parameter. When is_list is true, this is the type of each list element.", "enum": [ "string", "number", "boolean", "integer" ], "type": "string" }, "default": { "description": "The value bound when an optional parameter is omitted by the model. Required when is_optional is true. Its type must match data_type, and it must be an array when is_list is true; an explicit null is permitted. Type compatibility is validated by the server." }, "description": { "description": "A description of the parameter", "maxLength": 2000, "type": "string" }, "is_list": { "default": false, "description": "Whether the parameter is a list whose elements are of data_type. Defaults to false (a single scalar value).", "type": "boolean" }, "is_optional": { "default": false, "description": "Whether the model may omit the parameter. Defaults to false (the parameter is required). When true, a default value must be provided.", "type": "boolean" }, "name": { "description": "The name of the parameter", "type": "string" } }, "required": [ "name", "data_type", "description" ], "type": "object" }, "CypherTemplateTool": { "description": "A tool that runs a parameterized Cypher template.", "properties": { "config": { "description": "The Cypher template and its parameter definitions.", "properties": { "parameters": { "items": { "$ref": "#/components/schemas/CypherParameterConfig" }, "type": "array" }, "template": { "type": "string" } }, "required": [ "template" ], "type": "object" }, "description": { "maxLength": 2000, "type": "string" }, "enabled": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "type": { "enum": [ "cypherTemplate" ], "type": "string" } }, "required": [ "type", "name", "description", "config" ], "type": "object" }, "Database": { "description": "A DBMS database for a deployment", "properties": { "access": { "description": "Database access", "type": "string" }, "aliases": { "description": "Aliases in the database", "items": { "type": "string" }, "type": "array" }, "creation_time": { "description": "The time when the database was created", "format": "date-time", "type": "string" }, "current_primaries_count": { "description": "The current count of primary databases", "type": "string" }, "current_secondaries_count": { "description": "The current count of secondary databases", "type": "string" }, "default": { "description": "If this is the default database in the cluster", "type": "boolean" }, "last_start_time": { "description": "The time when the database was last started", "format": "date-time", "type": "string" }, "node_count": { "description": "The node count in the database", "type": "integer" }, "relationship_count": { "description": "The relationships count in the database", "type": "integer" }, "requested_primaries_count": { "description": "The requested amount of primary databases", "type": "string" }, "requested_secondaries_count": { "description": "The requested amount of secondary databases", "type": "string" }, "requested_status": { "description": "Requested database status", "type": "string" }, "store": { "description": "The store type for the database", "type": "string" } }, "type": "object" }, "DatabaseBackup": { "description": "Details about a Backup of an Aura Database", "properties": { "exportable": { "description": "Whether the Backup can be exported and downloaded", "type": "boolean" }, "id": { "description": "The ID of the Backup", "type": "string" }, "status": { "description": "The status of the Backup", "enum": [ "InProgress", "Failed", "Completed", "Pending" ], "type": "string" }, "timestamp": { "description": "The time the Backup was taken", "type": "string" } }, "required": [ "id", "timestamp", "status", "exportable" ], "type": "object" }, "DatabaseCreatedBy": { "description": "Information about the creator of the graph mapping.", "properties": { "database_username": { "description": "The database username.", "type": "string" }, "database_uuid": { "description": "The ID of the database the user is using.", "type": "string" }, "type": { "description": "The type of user that created the graph mapping. Always `DATABASE`.", "enum": [ "DATABASE" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "DatabaseSummary": { "description": "Summary information about an Aura Database", "properties": { "id": { "description": "The ID of the Database", "type": "string" } }, "type": "object" }, "DeleteGraphMappingResponse": { "description": "Response for deleting a graph mapping.", "properties": { "created_by": { "$ref": "#/components/schemas/DatabaseCreatedBy" }, "graph_name": { "description": "The name of the in-memory graph in the deleted graph mapping.", "type": "string" } }, "required": [ "graph_name", "created_by" ], "type": "object" }, "DeleteModelMetaResponse": { "description": "Response for deleting a model metadata entry.", "properties": { "name": { "description": "Name of the deleted model.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "DeleteSessionResponse": { "description": "Response for deleting a session.", "properties": { "id": { "description": "The ID of the deleted session.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "Deployment": { "description": "Describes a Fleet Manager deployment", "properties": { "connection_url": { "description": "The connection URL of the deployment", "type": "string" }, "created_by": { "description": "The ID of the user who created the deployment", "type": "string" }, "id": { "readOnly": true, "type": "string" }, "name": { "description": "The name of the deployment", "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "DetailedDeployment": { "description": "Describes a Fleet Manager deployment with more details", "properties": { "connection_url": { "description": "The connection URL of the deployment", "type": "string" }, "created_by": { "description": "The ID of the user who created the deployment", "type": "string" }, "dbms": { "description": "The DBMS of the deployment", "properties": { "edition": { "description": "The edition of the DBMS", "type": "string" }, "metric_collection_enabled": { "description": "Defines if metrics are collected for the DBMS", "type": "boolean" }, "packaging": { "description": "The packaging used by the DBMS", "type": "string" } }, "type": "object" }, "id": { "description": "The ID of the deployment", "readOnly": true, "type": "string" }, "name": { "description": "The name of the deployment", "type": "string" }, "token": { "description": "The token registered to the deployment", "properties": { "auto_rotate": { "description": "Defines if the token will auto renew on expiry", "type": "boolean" }, "claimed_time": { "description": "The time when the token was claimed by a DBMS", "format": "date-time", "type": "string" }, "created_by": { "description": "The ID of the user that created the token", "type": "string" }, "creation_time": { "description": "The time the token was created", "format": "date-time", "type": "string" }, "expiry_time": { "description": "The time when the token expires", "format": "date-time", "type": "string" }, "last_used_time": { "description": "The time the token was last used", "format": "date-time", "type": "string" }, "release_time": { "description": "The time the token was released", "format": "date-time", "type": "string" } }, "type": "object" } }, "type": "object" }, "GDSError": { "description": "Error response schema.", "properties": { "id": { "description": "A unique identifier for the error, useful for tracking and debugging.", "type": "string" }, "message": { "description": "A human-readable message providing more details about the error.", "type": "string" }, "reason": { "description": "A brief reason for the error, which can be used for categorization or filtering.", "type": "string" } }, "required": [ "message" ], "type": "object" }, "GraphMappingResponse": { "description": "A mapping between a GDS in-memory graph and a GDS session.", "properties": { "created_at": { "description": "The timestamp when the graph mapping was created.", "format": "date-time", "type": "string" }, "created_by": { "$ref": "#/components/schemas/DatabaseCreatedBy" }, "graph_name": { "description": "The name of the in-memory graph in the graph mapping.", "type": "string" }, "linked": { "description": "Whether the session should be deleted when the graph is deleted, i.e., implicit sessions created on graph projection.", "type": "boolean" }, "session_id": { "description": "The ID of the session in the graph mapping.", "type": "string" } }, "required": [ "graph_name", "session_id", "linked", "created_at", "created_by" ], "type": "object" }, "ImportExitStatus": { "properties": { "message": { "type": "string" }, "state": { "enum": [ "Success", "Failure", "Cancelled" ], "type": "string" } }, "type": "object" }, "ImportJob": { "properties": { "aura_target": { "properties": { "db_id": { "type": "string" }, "project_id": { "type": "string" } }, "type": "object" }, "data_source": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "import_type": { "enum": [ "cloud", "initial" ], "type": "string" }, "info": { "$ref": "#/components/schemas/ImportJobInfo" }, "user_id": { "type": "string" } }, "type": "object" }, "ImportJobEnvelope": { "description": "Envelope containing import job details", "properties": { "data": { "$ref": "#/components/schemas/ImportJob" } }, "type": "object" }, "ImportJobInfo": { "properties": { "cancellation_requested_time": { "format": "date-time", "type": "string" }, "completion_time": { "format": "date-time", "type": "string" }, "exit_status": { "$ref": "#/components/schemas/ImportExitStatus" }, "last_update_time": { "format": "date-time", "type": "string" }, "percentage_complete": { "format": "float", "type": "number" }, "progress": { "$ref": "#/components/schemas/ImportJobProgress" }, "start_time": { "format": "date-time", "type": "string" }, "state": { "enum": [ "SecretCreated", "ModelConfigMapOwnerUpdated", "Queued", "Running", "Completed" ], "type": "string" }, "submitted_time": { "format": "date-time", "type": "string" } }, "type": "object" }, "ImportJobProgress": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/NodeProgress" }, "type": "array" }, "relationships": { "items": { "$ref": "#/components/schemas/RelationshipProgress" }, "type": "array" } }, "type": "object" }, "InstanceDetails": { "description": "Detailed information about an Instance.", "properties": { "cloud_provider": { "description": "The cloud provider hosting the Instance", "enum": [ "gcp", "aws", "azure" ], "type": "string" }, "graph_analytics": { "description": "The graph analytics capability of the Instance", "enum": [ "unavailable", "serverless", "plugin" ], "type": "string" }, "id": { "description": "The ID of the Instance", "type": "string" }, "legacy_status": { "description": "The status of the Instance in the legacy v1 response format.", "enum": [ "creating", "pausing", "suspending", "loading", "restoring", "updating", "overwriting", "resuming", "destroying", "resizing", "loading failed", "running", "paused", "suspended", "encryption key deleted", "encryption key error", "encryption key not found", "upgrading" ], "type": "string" }, "memory": { "description": "The size of the Instance memory", "nullable": true, "type": "string" }, "multi_database": { "description": "Whether multi-database is enabled", "type": "boolean" }, "name": { "description": "The name of the Instance", "type": "string" }, "region": { "description": "The region where the Instance is hosted", "type": "string" }, "storage": { "description": "The size of the Instance storage", "nullable": true, "type": "string" }, "type": { "description": "The type of the Instance", "enum": [ "enterprise-db", "enterprise-ds", "business-critical", "professional-db", "professional-ds", "free-db" ], "type": "string" }, "vector_optimized": { "description": "Whether the Instance is vector optimized", "type": "boolean" } }, "required": [ "id", "name", "type", "cloud_provider", "region", "multi_database", "graph_analytics", "vector_optimized", "legacy_status" ], "type": "object" }, "InstanceSummary": { "description": "Summary of an Instance.", "properties": { "cloud_provider": { "description": "The cloud provider hosting the Instance", "enum": [ "gcp", "aws", "azure" ], "type": "string" }, "created_at": { "description": "The timestamp when the Instance was created", "format": "date-time", "type": "string" }, "id": { "description": "The ID of the Instance", "type": "string" }, "name": { "description": "The name of the Instance", "type": "string" } }, "required": [ "id", "name", "cloud_provider", "created_at" ], "type": "object" }, "InvokeAgentContent": { "description": "A single content block produced by an agent during invocation.", "properties": { "id": { "description": "The tool use ID (for `tool_use` and `cypher_template_tool_use` types)", "type": "string" }, "input": { "additionalProperties": true, "description": "The tool input (for `tool_use` and `cypher_template_tool_use` types)", "type": "object" }, "name": { "description": "The tool name (for `tool_use` and `cypher_template_tool_use` types)", "type": "string" }, "output": { "additionalProperties": true, "description": "The tool output (for `tool_result` and `cypher_template_tool_result` types)", "type": "object" }, "text": { "description": "Text content (for `text` type)", "type": "string" }, "thinking": { "description": "Thinking content (for `thinking` type)", "type": "string" }, "tool_use_id": { "description": "The referenced tool use ID (for `tool_result` and `cypher_template_tool_result` types)", "type": "string" }, "type": { "description": "The content block type.", "enum": [ "text", "thinking", "tool_use", "tool_result", "cypher_template_tool_use", "cypher_template_tool_result" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "InvokeAgentError": { "description": "Error details returned when an invocation fails.", "properties": { "message": { "description": "Human-readable error message.", "type": "string" }, "status_code": { "description": "Upstream HTTP status code, when applicable.", "type": "integer" }, "type": { "description": "Error category (for example `EXECUTION_ERROR`).", "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "InvokeAgentResponse": { "description": "The response body returned by a non-streaming agent invocation.", "properties": { "content": { "description": "Content blocks in the response message (for `message` responses).", "items": { "$ref": "#/components/schemas/InvokeAgentContent" }, "type": "array" }, "end_reason": { "description": "The reason the response ended. For successful invocations this is\n`FINAL_ANSWER_PROVIDED`.", "type": "string" }, "error": { "$ref": "#/components/schemas/InvokeAgentError" }, "role": { "description": "The role of the responder (for `message` responses, always `assistant`).", "type": "string" }, "status": { "description": "The status of the invocation. For successful invocations this is `SUCCESS`.", "type": "string" }, "type": { "description": "The response type", "enum": [ "message", "error" ], "type": "string" }, "usage": { "$ref": "#/components/schemas/InvokeAgentUsage" } }, "required": [ "type" ], "type": "object" }, "InvokeAgentUsage": { "description": "Token usage for an agent invocation.", "properties": { "request_tokens": { "description": "Number of tokens consumed by the request (prompt and tool inputs).", "type": "integer" }, "response_tokens": { "description": "Number of tokens produced in the response (including reasoning tokens).", "type": "integer" }, "total_tokens": { "description": "Sum of request and response tokens.", "type": "integer" } }, "type": "object" }, "IpFilter": { "description": "Describes an IP filter", "properties": { "allow_list": { "description": "A list of CIDR that are allowed by the filter", "items": { "properties": { "address": { "description": "The CIDR IP address", "type": "string" }, "description": { "description": "A human-friendly description of the CIDR", "type": "string" }, "prefix_len": { "description": "The prefix length of the CIDR", "type": "integer" } }, "required": [ "address", "prefix_len" ], "type": "object" }, "type": "array" }, "description": { "description": "The name of the project", "type": "string" }, "filtered_entities": { "description": "The entities that are currently filtered by this IP filter rule", "properties": { "instances": { "description": "A list containing a summary of Aura instances filtered by this IP filter rule", "items": { "description": "The id of the instance configuration that is filtered by this IP filter rule", "type": "string" }, "type": "array" }, "organizations": { "description": "A list of organizations that are filtered by this IP filter rule", "items": { "description": "The id of the organization that is filtered by this IP filter rule", "type": "string" }, "type": "array" }, "projects": { "description": "A list of projects that are filtered by this IP filter rule", "items": { "description": "The id of the project that is filtered by this IP filter rule", "type": "string" }, "type": "array" } }, "type": "object" }, "filtering_disabled": { "description": "Indicates if the IP filter is disabled", "type": "boolean" }, "id": { "readOnly": true, "type": "string" }, "name": { "description": "The name of the IP filter", "type": "string" }, "organization_id": { "description": "The id of the organization that owns the IP filter", "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object" }, "JobIdEnvelope": { "description": "Envelope containing a job ID", "properties": { "data": { "properties": { "id": { "type": "string" } }, "type": "object" } }, "type": "object" }, "LedgerData": { "description": "Represents credit ledger data for an organization, including balance and credit information", "properties": { "balance_date": { "example": "2024-01-02T00:00:00Z", "format": "date-time", "type": "string" }, "billing_account_id": { "example": "7f3e9a2b-d73f-4e91-856a-8d2c1f6e4a9c", "type": "string" }, "initial_credit_quantity": { "example": 10000, "format": "double", "type": "number" }, "organization_id": { "example": "3ca1e9b8-4c8d-4b21-b5a3-bc4f73d91642", "type": "string" }, "remaining_credit_quantity": { "example": 9342, "format": "double", "type": "number" } }, "type": "object" }, "Links": { "properties": { "first": { "format": "uri", "type": "string" }, "next": { "format": "uri", "nullable": true, "type": "string" }, "self": { "format": "uri", "type": "string" } }, "type": "object" }, "ModelCreatedBy": { "description": "Information about the creator of the model.", "properties": { "console_user_id": { "description": "The ID of the console user. Only present when `type` is `CONSOLE`.", "format": "uuid", "type": "string" }, "database_username": { "description": "The database username. Only present when `type` is `DATABASE`.", "type": "string" }, "instance_id": { "description": "The instance the user is using. Only present when `type` is `DATABASE`.", "type": "string" }, "type": { "description": "The type of user that created the model.", "enum": [ "CONSOLE", "DATABASE" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "ModelMeta": { "description": "Metadata describing a graph analytics model.", "properties": { "created_at": { "description": "The timestamp when the model was created.", "format": "date-time", "type": "string" }, "created_by": { "$ref": "#/components/schemas/ModelCreatedBy" }, "id": { "description": "The unique identifier of the model.", "format": "uuid", "type": "string" }, "name": { "description": "The name of the model.", "type": "string" }, "project_id": { "description": "The project the model belongs to.", "format": "uuid", "type": "string" }, "publish_scope": { "description": "The publish scope of the model.", "enum": [ "PRIVATE", "PROJECT" ], "type": "string" }, "size_in_bytes": { "description": "The size of the model in bytes.", "format": "int64", "type": "integer" }, "storage_location": { "description": "The storage location of the model.", "type": "string" } }, "required": [ "id", "name", "project_id", "storage_location", "publish_scope", "size_in_bytes", "created_at", "created_by" ], "type": "object" }, "NodeProgress": { "properties": { "created_constraints": { "type": "integer" }, "created_indexes": { "type": "integer" }, "created_nodes": { "type": "integer" }, "id": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "processed_rows": { "type": "integer" }, "total_rows": { "type": "integer" } }, "type": "object" }, "OrganizationDetails": { "description": "Holds details about an Aura Organization", "properties": { "id": { "description": "The UUID of the Aura organization", "type": "string" }, "name": { "description": "The name of the company", "type": "string" } }, "type": "object" }, "OrganizationInvite": { "description": "Holds details about an invite to an Aura Organization", "properties": { "email": { "description": "The email this invite is sent to", "type": "string" }, "expires_at": { "description": "The time after which this invite will no longer be possible to accept", "format": "date-time", "type": "string" }, "id": { "description": "The UUID of the invite", "format": "uuid", "type": "string" }, "invited_by": { "description": "The UUID of the user who created the invite", "format": "uuid", "type": "string" }, "organization_id": { "description": "The UUID of the organization", "format": "uuid", "type": "string" }, "organization_roles": { "description": "Organization roles this invite will grant to the invitee", "items": { "enum": [ "organization-owner", "organization-admin", "organization-member" ], "type": "string" }, "type": "array" }, "project_invites": { "description": "Project roles to be assigned to the invitee", "items": { "properties": { "project_id": { "description": "UUID of an organization's project", "format": "uuid", "type": "string" }, "project_roles": { "description": "List of project roles", "items": { "enum": [ "namespace-viewer", "namespace-member", "namespace-admin", "namespace-metrics-integration-reader" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "description": "Status of the invite", "enum": [ "active", "accepted", "revoked", "expired", "declined" ], "type": "string" } }, "type": "object" }, "OrganizationUser": { "description": "A user within an Aura Organization", "properties": { "email": { "description": "The email address of the user", "format": "email", "type": "string" }, "exempt_from_automatic_removal": { "description": "Whether the user is exempt from automatic removal due to inactivity", "type": "boolean" }, "last_activity_at": { "description": "The timestamp of the user's last activity", "format": "date-time", "nullable": true, "type": "string" }, "mfa_enrolled_methods": { "description": "The MFA methods the user has enrolled in", "items": { "properties": { "enrolled_at": { "description": "The timestamp when the user enrolled in this MFA method", "format": "date-time", "type": "string" }, "id": { "description": "The MFA method identifier", "enum": [ "totp" ], "type": "string" } }, "required": [ "id", "enrolled_at" ], "type": "object" }, "type": "array" }, "mfa_enrollment_status": { "description": "The MFA enrollment status of the user", "enum": [ "enrolled", "not_enrolled", "external_auth_provider", "non_applicable" ], "type": "string" }, "organization_roles": { "description": "The user's roles within the organization", "items": { "type": "string" }, "type": "array" }, "user_id": { "description": "The UUID of the user", "format": "uuid", "type": "string" } }, "required": [ "user_id", "email", "organization_roles", "exempt_from_automatic_removal", "mfa_enrollment_status", "mfa_enrolled_methods", "last_activity_at" ], "type": "object" }, "OrganizationUserDetails": { "allOf": [ { "$ref": "#/components/schemas/OrganizationUser" }, { "properties": { "projects": { "description": "The projects the user has access to within the organization", "items": { "$ref": "#/components/schemas/OrganizationUserProject" }, "type": "array" } }, "required": [ "projects" ], "type": "object" } ], "description": "Detailed information about a user in an Aura Organization, including project-level access" }, "OrganizationUserProject": { "description": "A project membership for a user within an organization", "properties": { "id": { "description": "The UUID of the project", "format": "uuid", "type": "string" }, "name": { "description": "The name of the project", "type": "string" }, "project_roles": { "description": "The user's roles within the project", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "project_roles" ], "type": "object" }, "ProjectDetails": { "description": "Holds details about a project", "properties": { "id": { "description": "The UUID of the project", "type": "string" }, "name": { "description": "The name of the project", "type": "string" } }, "type": "object" }, "ProjectUser": { "description": "A user within an Aura Project", "properties": { "email": { "description": "The email address of the user", "format": "email", "type": "string" }, "project_roles": { "description": "The roles assigned to the user within the project", "items": { "type": "string" }, "type": "array" }, "user_id": { "description": "The UUID of the user", "format": "uuid", "type": "string" } }, "required": [ "user_id", "email", "project_roles" ], "type": "object" }, "RelationshipProgress": { "properties": { "created_constraints": { "type": "integer" }, "created_indexes": { "type": "integer" }, "created_relationships": { "type": "integer" }, "id": { "type": "string" }, "processed_rows": { "type": "integer" }, "total_rows": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "Server": { "description": "A DBMS server for a deployment", "properties": { "address": { "description": "The address of the server", "type": "string" }, "jvm_vendor": { "description": "The JVM vendor of the server", "type": "string" }, "jvm_version": { "description": "The JVM version of the server", "type": "string" }, "last_ping": { "description": "The time when the server last pinged fleet-manager-api", "format": "date-time", "type": "string" }, "license": { "description": "The license on the server", "properties": { "days_left_on_trial": { "description": "The amount of days left on the trial", "type": "integer" }, "state": { "description": "The state of the license", "enum": [ "VALID", "EXPIRED", "NOT_ACCEPTED", "INVALID", "UNKNOWN", "INCONSISTENT" ], "type": "string" }, "total_trial_days": { "description": "The total amount of days on the trial", "type": "integer" }, "type": { "description": "The type of the license", "enum": [ "FREE", "COMMERCIAL", "EVALUATION", "UNSUPPORTED", "INCONSISTENT" ], "type": "string" } }, "type": "object" }, "mode_constraints": { "description": "The mode constraint of the server", "type": "string" }, "name": { "description": "The name of the server", "type": "string" }, "os_name": { "description": "The OS name of the server", "type": "string" }, "os_version": { "description": "The OS version of the server", "type": "string" }, "plugin_version": { "description": "The version of the plugin running on the server", "type": "string" }, "plugins": { "description": "The plugins installed on the server", "items": { "properties": { "filename": { "description": "The filename of the plugin", "type": "string" }, "name": { "description": "The name of the plugin", "type": "string" }, "version": { "description": "The version of the plugin", "type": "string" } }, "type": "object" }, "type": "array" }, "state": { "description": "The state of the server", "type": "string" }, "status": { "description": "The status of the server", "type": "string" }, "version": { "description": "The version of the server", "type": "string" } }, "type": "object" }, "ServerDatabase": { "description": "A DBMS server database for a deployment", "properties": { "current_status": { "description": "The current status of the database", "type": "string" }, "graph_shards": { "description": "The graph shards of the database", "items": { "type": "string" }, "type": "array" }, "last_committed_txn": { "description": "The number of the last committed transaction", "type": "integer" }, "name": { "description": "The name of the database", "type": "string" }, "property_shards": { "description": "The property shards of the database", "items": { "type": "string" }, "type": "array" }, "replication_lag": { "description": "The replication lag on the database", "type": "integer" }, "role": { "description": "The role of the database", "type": "string" }, "status_message": { "description": "The current status message of the database", "type": "string" }, "type": { "description": "The type of the database", "type": "string" }, "writer": { "description": "Defines if this database is a writer in the cluster", "type": "boolean" } }, "type": "object" }, "SessionCreatedBy": { "description": "Information about the creator of the session.", "properties": { "console_user_id": { "description": "The UUID of the console user. Only present when `type` is `CONSOLE`.", "format": "uuid", "type": "string" }, "database_username": { "description": "The database username. Only present when `type` is `DATABASE`.", "type": "string" }, "database_uuid": { "description": "The ID of the database the user is using. Only present when `type` is `DATABASE`.", "type": "string" }, "type": { "description": "The type of user that created the session.", "enum": [ "CONSOLE", "DATABASE" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "SessionResponse": { "description": "A GDS session.", "properties": { "cloud_provider": { "description": "The cloud provider the session is running in.", "nullable": true, "type": "string" }, "created_at": { "description": "The timestamp when the session was created.", "format": "date-time", "type": "string" }, "created_by": { "$ref": "#/components/schemas/SessionCreatedBy" }, "database_id": { "description": "The ID of the AuraDatabase associated with the session. Relevant for Aura multi-db instances.", "nullable": true, "type": "string" }, "expiry_date": { "description": "The timestamp when the session will expire. Independent of the TTL.", "format": "date-time", "type": "string" }, "host": { "description": "The hostname of the session, used to connect to it from the client.", "type": "string" }, "id": { "description": "The ID of the session.", "type": "string" }, "instance_id": { "description": "The ID of the AuraInstance associated with the session. Projection and write-back are limited to this database.", "type": "string" }, "memory": { "description": "The memory allocated to the session, e.g., \"2GB\".", "type": "string" }, "name": { "description": "The name of the session, given by the user on creation. Should be descriptive and unique on a project level.", "type": "string" }, "project_id": { "description": "The ID of the console project the session belongs to.", "type": "string" }, "region": { "description": "The region the session is running in.", "nullable": true, "type": "string" }, "status": { "description": "The status of the session.", "enum": [ "Creating", "Ready", "NotReady", "Expired", "Failed", "Deleted" ], "type": "string" }, "ttl": { "description": "The TTL of the session as a duration string, e.g., \"1h0m0s\". Refreshes on usage of the session. Only present if relevant.", "example": "1h0m0s", "type": "string" } }, "required": [ "id", "instance_id", "name", "memory", "status", "host", "project_id", "created_at", "created_by" ], "type": "object" }, "SessionSizeResponse": { "description": "An estimated memory size for a session.", "properties": { "estimated_memory": { "description": "The estimated memory required, e.g., \"1.6GB\".", "type": "string" }, "recommended_size": { "description": "The recommended session size, e.g., \"2GB\".", "type": "string" } }, "required": [ "recommended_size", "estimated_memory" ], "type": "object" }, "SimilaritySearchTool": { "description": "A tool that performs vector similarity search against a vector index.", "properties": { "config": { "description": "The vector similarity search configuration.", "properties": { "dimensions": { "description": "The embedding dimensions, when the provider or index requires an explicit size.", "type": "integer" }, "index": { "description": "The name of the vector index to query.", "maxLength": 100, "type": "string" }, "model": { "description": "The embedding model. Must be compatible with the selected provider.\nSupported `openai` models: `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002`.\nSupported `vertexai` models: `gemini-embedding-001`, `text-embedding-005`, `text-multilingual-embedding-002`.", "type": "string" }, "post_processing_cypher": { "description": "Optional read-only Cypher appended to the vector search and executed as a single query. \nThe matched node and its score are exposed as `node` and `score`. Write queries are rejected.", "type": "string" }, "provider": { "description": "The embedding provider used to generate query embeddings.", "enum": [ "openai", "vertexai" ], "type": "string" }, "top_k": { "description": "The maximum number of matches to return.", "maximum": 100, "minimum": 1, "type": "integer" } }, "required": [ "provider", "model", "index", "top_k" ], "type": "object" }, "description": { "maxLength": 2000, "type": "string" }, "enabled": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "type": { "enum": [ "similaritySearch" ], "type": "string" } }, "required": [ "type", "name", "description", "config" ], "type": "object" }, "Text2CypherTool": { "description": "A tool that converts natural language to Cypher queries.", "properties": { "config": { "description": "This tool type takes no configuration.", "type": "object" }, "description": { "maxLength": 2000, "type": "string" }, "enabled": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "type": { "enum": [ "text2cypher" ], "type": "string" } }, "required": [ "type", "name", "description" ], "type": "object" }, "Tool": { "description": "A tool attached to an agent. The configuration is type-specific.", "discriminator": { "mapping": { "cypherTemplate": "#/components/schemas/CypherTemplateTool", "similaritySearch": "#/components/schemas/SimilaritySearchTool", "text2cypher": "#/components/schemas/Text2CypherTool" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CypherTemplateTool" }, { "$ref": "#/components/schemas/SimilaritySearchTool" }, { "$ref": "#/components/schemas/Text2CypherTool" } ] }, "UsageData": { "description": "Represents usage data for billing purposes, including resource consumption and pricing details", "properties": { "billable_size": { "description": "Size of the billable resource. This field is omitted when the size is zero or not available.", "example": 32, "format": "int64", "type": "integer" }, "billable_size_unit": { "description": "Unit of the resource size (e.g., GB). This field is omitted when the resource size is not available.", "example": "GB", "type": "string" }, "billing_account_id": { "example": "8c63f675-ed21-4af0-ac4e-66ce2b3c2c7b", "type": "string" }, "billing_account_type": { "example": "payg", "type": "string" }, "charge_period_end": { "example": "2024-01-03T00:00:00Z", "format": "date-time", "type": "string" }, "charge_period_start": { "example": "2024-01-02T00:00:00Z", "format": "date-time", "type": "string" }, "cloud_service_provider": { "example": "gcp", "type": "string" }, "consumed_quantity": { "example": 20, "format": "double", "type": "number" }, "consumed_unit": { "example": "GB-hours", "type": "string" }, "invoice_issuer_name": { "example": "direct", "type": "string" }, "list_cost": { "example": 4, "format": "double", "type": "number" }, "list_unit_price": { "example": 0.2, "format": "double", "type": "number" }, "organization_id": { "example": "8ba9ffc7-c86c-4f88-9370-af9852583158", "type": "string" }, "payment_method": { "example": "creditcard", "type": "string" }, "pricing_currency": { "example": "credits", "type": "string" }, "project_id": { "example": "550e8400-e29b-41d4-a716-446655440000", "type": "string" }, "project_name": { "example": "My Project", "type": "string" }, "region_id": { "example": "us-east1", "type": "string" }, "resource_id": { "example": "8ba9ffc7", "type": "string" }, "resource_name": { "example": "My Database Name", "type": "string" }, "resource_type": { "example": "Instance", "type": "string" }, "service_name": { "example": "Primary DB", "type": "string" }, "tier": { "example": "business_critical", "type": "string" } }, "type": "object" }, "VirtualGraph": { "description": "A Virtual Graph instance in the caller's project.", "properties": { "bolt_url": { "description": "Bolt connection URL for the instance.", "type": "string" }, "cloud_provider": { "description": "Cloud provider the instance is deployed on.", "enum": [ "gcp", "aws", "azure" ], "type": "string" }, "created_at": { "description": "Creation timestamp.", "format": "date-time", "type": "string" }, "data_source_id": { "description": "ID of the federated data source backing this instance.", "type": "string" }, "data_source_type": { "description": "Data source connector type.", "type": "string" }, "error_detail": { "description": "User-facing error detail when status is ERROR.", "type": "string" }, "id": { "description": "Virtual Graph instance ID (for example ge82059a).", "type": "string" }, "maximum_bytes_billed": { "description": "Per-query bytes-billed cap. Present only for BigQuery-backed instances.", "format": "int64", "type": "integer" }, "memory": { "description": "Allocated memory (for example 4Gi).", "type": "string" }, "name": { "description": "User-defined display name.", "type": "string" }, "region": { "description": "Cloud region the instance is deployed in.", "type": "string" }, "status": { "description": "Lifecycle state.", "enum": [ "creating", "running", "updating", "error", "deleted" ], "type": "string" } }, "type": "object" }, "VirtualGraphAllowedConfigs": { "description": "Allowed configurations for Virtual Graph instances in the caller's project.", "properties": { "configs": { "description": "Selectable configurations for a Virtual Graph instance.", "example": [ { "memory": "4Gi", "price": { "amount": "0.5", "metric_unit": "hour", "sku": "virtual-graph-4gi" } }, { "memory": "8Gi", "price": { "amount": "1.0", "metric_unit": "hour", "sku": "virtual-graph-8gi" } } ], "items": { "properties": { "memory": { "description": "Memory allocation (for example 4Gi).", "type": "string" }, "price": { "description": "Resolved price for this configuration. Omitted when no price could be resolved.", "properties": { "amount": { "description": "Unit price as a decimal string (for example 0.5).", "type": "string" }, "metric_unit": { "description": "Billing unit the price applies to (for example hour).", "type": "string" }, "sku": { "description": "Consumption SKU the price belongs to.", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "default_memory": { "description": "Default setting applied when omitted on create.", "example": "4Gi", "type": "string" } }, "type": "object" }, "VirtualGraphCreateResponse": { "allOf": [ { "$ref": "#/components/schemas/VirtualGraph" }, { "properties": { "plain_password": { "description": "Initial Neo4j password. Returned only on create; store securely.", "type": "string" } }, "required": [ "plain_password" ], "type": "object" } ] } }, "securitySchemes": { "oauthToken": { "flows": { "clientCredentials": { "scopes": {}, "tokenUrl": "https://api.neo4j.io/v2beta1/oauth/token" } }, "type": "oauth2" } } }, "info": { "contact": {}, "description": "This is the v2beta1 release of the Aura API.\n\nFor more information on how to use the API, see the [Aura API documentation](https://neo4j.com/docs/aura/api/overview/).\n\n[Provide feedback](https://docs.google.com/forms/d/e/1FAIpQLSfNZMyQRnI_ZzK8IJ2E266DP_-zLDBWzk1OaUkPem16V-ekZQ/viewform) on the Aura API.", "termsOfService": "https://console.neo4j.io/#terms", "title": "Aura API", "version": "v2beta1" }, "openapi": "3.0.0", "paths": { "/organizations": { "get": { "description": "Returns a list of Aura Organizations.", "operationId": "list-organizations", "responses": { "200": { "content": { "application/json": { "examples": { "Get organizations": { "value": { "data": [ { "id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "name": "MetaCortex" }, { "id": "faaa3547-eaf8-405e-812e-e0bba04a1834", "name": "Zion" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationDetails" }, "type": "array" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Get a list of organizations", "tags": [ "organizations" ] } }, "/organizations/{org_id}": { "get": { "description": "Returns information about an Aura Organization.", "operationId": "show-organization", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get org info": { "value": { "data": { "id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "name": "MetaCortex" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationDetails" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Get an organization by its ID", "tags": [ "organizations" ] } }, "/organizations/{org_id}/activity-feed": { "get": { "description": "Get activity feed for the given organization.", "operationId": "get-organization-activity-feed", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ActivityLog" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the activity feed." } }, "security": [ { "oauthToken": [] } ], "summary": "Get activity feed for the given organization", "tags": [ "activity-feed" ] } }, "/organizations/{org_id}/billing/ledger": { "get": { "description": "Returns credit ledger rows for a given organization and time range.\nThe `start` and `end` parameters are required and must be RFC3339 timestamps (e.g., `2024-01-02T00:00:00Z`).", "operationId": "get-ledger", "parameters": [ { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_token", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_limit", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LedgerData" }, "type": "array" }, "links": { "$ref": "#/components/schemas/Links" } }, "type": "object" } } }, "description": "Ledger data returned successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingErrorResponse" } } }, "description": "Bad request (missing or invalid parameters)" }, "500": { "description": "Internal server error (ledger load failed)" } }, "security": [ { "oauthToken": [] } ], "summary": "Get credit ledger for an organization", "tags": [ "billing" ] } }, "/organizations/{org_id}/billing/usage": { "get": { "description": "Returns usage rows for a given organization and time range.\nThe `start` and `end` parameters are required and must be RFC3339 timestamps (e.g., `2024-01-02T00:00:00Z`).", "operationId": "get-usage", "parameters": [ { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_token", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_limit", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/UsageData" }, "type": "array" }, "links": { "$ref": "#/components/schemas/Links" } }, "type": "object" } } }, "description": "Usage data returned successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingErrorResponse" } } }, "description": "Bad request (missing or invalid parameters)" }, "500": { "description": "Internal server error (usage load failed)" } }, "security": [ { "oauthToken": [] } ], "summary": "Get billed usage for an organization", "tags": [ "billing" ] } }, "/organizations/{org_id}/graph-analytics/sessions": { "get": { "description": "Lists sessions visible to either an organization owner or admin, optionally filtered by instance, database, owner, and creation date, with pagination.", "operationId": "list-org-sessions", "parameters": [ { "in": "query", "name": "list_only_owned", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include_deleted", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Session list": { "value": { "data": [ { "cloud_provider": "gcp", "created_at": "2026-06-15T14:16:04Z", "created_by": { "database_username": "neo4j", "database_uuid": "abcd1234", "type": "DATABASE" }, "database_id": null, "expiry_date": "2026-06-22T14:16:04Z", "host": "s-d8c78075-6dd3-4-gds.\u003cORCHESTRA\u003e.neo4j.io", "id": "s-d8c78075-6dd3-4", "instance_id": "", "memory": "2GB", "name": "my-session", "project_id": "828b30d5-55d1-421f-8ed6-fc6a7fa4a623", "region": "europe-west1", "status": "Ready", "ttl": "1h0m0s" } ], "errors": [] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "OK. Sessions returned." }, "400": { "description": "Bad Request. The request or a filter is invalid." }, "401": { "description": "Unauthorized. Not authenticated or missing permission." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "List sessions for organization", "tags": [ "graph-analytics" ] } }, "/organizations/{org_id}/invites": { "get": { "description": "Returns a list of pending and historical invites for an Aura Organization. Requires the caller to be an organization admin.", "operationId": "list-organization-invites", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List organization invites": { "value": { "data": [ { "email": "colleague@example.com", "expires_at": "2026-07-08T12:00:00.000000Z", "id": "5f30db99-83e8-42d8-b542-bcbb10e6c507", "invited_by": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "organization_roles": [ "organization-member" ], "project_invites": [ { "project_id": "89fcc404-a509-488e-a3a4-53d3e80b99b7", "project_roles": [ "namespace-member" ] } ], "status": "active" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationInvite" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not an organization admin." }, "404": { "description": "Organization not found." } }, "security": [ { "oauthToken": [] } ], "summary": "List organization invites", "tags": [ "organizations" ] }, "post": { "description": "Creates an Aura Organization invite. Requires the caller to be an organization admin.", "operationId": "create-organization-invite", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The request body for creating an Aura Organization invite", "properties": { "email": { "description": "The e-mail the invite will be sent to", "type": "string" }, "project_invites": { "description": "Project roles to be assigned to the invitee", "items": { "properties": { "project_id": { "description": "UUID of an organization's project", "format": "uuid", "type": "string" }, "project_roles": { "description": "List of project roles", "items": { "enum": [ "namespace-viewer", "namespace-member", "namespace-admin", "namespace-metrics-integration-reader" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roles": { "description": "The organization roles the invitee wil be assigned", "items": { "enum": [ "organization-owner", "organization-admin", "organization-member" ], "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "Created organization invite": { "value": { "data": { "email": "morpheus@nebuchadnezzar.net", "expires_at": "2026-07-08T12:00:00.000000Z", "id": "5f30db99-83e8-42d8-b542-bcbb10e6c507", "invited_by": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "organization_roles": [ "organization-member" ], "project_invites": [ { "project_id": "89fcc404-a509-488e-a3a4-53d3e80b99b7", "project_roles": [ "namespace-member" ] } ], "status": "active" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationInvite" } }, "type": "object" } } }, "description": "Created" }, "400": { "description": "Bad request. Invite cannot be created." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not an organization admin." }, "404": { "description": "Organization not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Create an organization invite", "tags": [ "organizations" ] } }, "/organizations/{org_id}/invites/{invite_id}": { "delete": { "description": "Deletes an Aura Organization invite. Requires the caller to be an organization admin.", "operationId": "delete-organization-invite", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "invite_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad request. Invite cannot be deleted." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not an organization admin." }, "404": { "description": "Invite or organization not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Delete an organization invite", "tags": [ "organizations" ] } }, "/organizations/{org_id}/ip-filters": { "get": { "description": "Returns a list of IP filters of the organization.\n\nFor an IP filter's status on individual databases please see the \n``/organizations/{organizationId}/projects/{projectId}/instances/{instanceId}ip-filters``\nendpoint.", "operationId": "list-ip-filters", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List of IP filters": { "value": [ { "allow_list": [ { "address": "192.168.1.1", "description": "Office Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "some-instance-id" ], "organizations": [], "projects": [] }, "filtering_disabled": false, "id": 12345678, "name": "My IP filter", "organization_id": "example-org-id" }, { "allow_list": [ { "address": "192.168.1.1", "description": "Home Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "other-id-1", "other-id-2" ], "organizations": [], "projects": [ "project-id" ] }, "filtering_disabled": false, "id": 87654321, "name": "My Other IP filter", "organization_id": "example-org-id" } ] } }, "schema": { "items": { "$ref": "#/components/schemas/IpFilter" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Returns a list of IP filters for the organization", "tags": [ "ip-filters" ] }, "post": { "description": "Create a new IP filter.", "operationId": "create-ip-filter", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Created IP filter": { "value": { "allow_list": [ { "address": "192.168.1.1", "description": "Office Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "some-instance-id" ], "projects": [] }, "filtering_disabled": false, "id": 12345678, "name": "My IP filter", "organization_id": "example-org-id" } } }, "schema": { "$ref": "#/components/schemas/IpFilter" } } }, "description": "Created" } }, "security": [ { "oauthToken": [] } ], "summary": "Creates a new IP filter for the organization", "tags": [ "ip-filters" ] } }, "/organizations/{org_id}/ip-filters/{ip_filter_id}": { "delete": { "description": "Deletes an existing IP filter.", "operationId": "delete-ip-filter", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ip_filter_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "oauthToken": [] } ], "summary": "Deletes an existing IP filter", "tags": [ "ip-filters" ] }, "get": { "description": "Returns a specific IP filter by its ID.\n\nFor an IP filter's status on individual instances see the \n``/organizations/{organizationId}/projects/{projectId}/instances/{instanceId}ip-filters``\nendpoint.", "operationId": "get-ip-filter", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ip_filter_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Specific IP filters": { "value": { "allow_list": [ { "address": "192.168.1.1", "description": "Office Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "some-instance-id" ], "organizations": [], "projects": [] }, "filtering_disabled": false, "id": 12345678, "name": "My IP filter", "organization_id": "example-org-id" } } }, "schema": { "$ref": "#/components/schemas/IpFilter" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Returns a specific IP filter of the organization", "tags": [ "ip-filters" ] }, "patch": { "description": "Updates an existing IP filter.", "operationId": "update-ip-filter", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ip_filter_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Updated IP filter": { "value": { "allow_list": [ { "address": "192.168.1.1", "description": "Office Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "some-instance-id" ], "projects": [] }, "filtering_disabled": false, "id": 12345678, "name": "My IP filter", "organization_id": "example-org-id" } } }, "schema": { "$ref": "#/components/schemas/IpFilter" } } }, "description": "Created" } }, "security": [ { "oauthToken": [] } ], "summary": "Updates an existing IP filter", "tags": [ "ip-filters" ] } }, "/organizations/{org_id}/projects": { "get": { "description": "Returns a list of projects with status active for a given Aura organization.", "operationId": "list-projects", "parameters": [ { "description": "Filter projects by status", "in": "query", "name": "status", "schema": { "enum": [ "deletion_request", "deleted", "active" ], "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List projects": { "value": { "data": [ { "id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac", "name": "Operation Dark Koala" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectDetails" }, "type": "array" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "List projects", "tags": [ "projects" ] } }, "/organizations/{org_id}/projects/{project_id}/activity-feed": { "get": { "description": "Get activity feed for the given project.", "operationId": "get-project-activity-feed", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ActivityLog" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the activity feed." } }, "security": [ { "oauthToken": [] } ], "summary": "Get activity feed for the given project", "tags": [ "activity-feed" ] } }, "/organizations/{org_id}/projects/{project_id}/agents": { "get": { "description": "Returns a list of agents for the specified project.", "operationId": "list-agents", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List agents": { "value": [ { "dbid": "a1b2c3d4", "description": "An agent that queries the database", "enabled": true, "endpoint_link": "https://agent.example.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "is_mcp_enabled": false, "is_private": false, "mcp_endpoint_link": "https://agent.example.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/mcp", "name": "My Agent", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee", "tools": [ { "name": "query-tool", "type": "text2cypher" } ] } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AgentSummary" }, "type": "array" } } }, "description": "OK" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "List agents", "tags": [ "agents" ] }, "post": { "description": "Creates a new agent for the specified project.", "operationId": "create-agent", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Create agent with cypherTemplate tool": { "value": { "dbid": "a1b2c3d4", "description": "An agent using a Cypher template", "is_private": true, "name": "Template Agent", "tools": [ { "config": { "parameters": [ { "data_type": "string", "description": "The movie title to search for", "name": "title" } ], "template": "MATCH (m:Movie) WHERE m.title CONTAINS $title RETURN m" }, "description": "Finds movies by title", "enabled": true, "name": "find-movies", "type": "cypherTemplate" } ] } }, "Create agent with similaritySearch tool": { "value": { "dbid": "a1b2c3d4", "description": "An agent using vector similarity search", "is_private": false, "name": "Search Agent", "tools": [ { "config": { "dimensions": 1536, "index": "my-vector-index", "model": "text-embedding-ada-002", "post_processing_cypher": "MATCH (node)\u003c-[:ACTED_IN]-(actor:Person)\nRETURN node.title AS title, actor.name AS actor, score", "provider": "openai", "top_k": 10 }, "description": "Performs vector similarity search", "enabled": true, "name": "similarity-search", "type": "similaritySearch" } ] } }, "Create agent with text2cypher tool": { "value": { "dbid": "a1b2c3d4", "description": "An agent that queries the database", "is_private": false, "name": "My Agent", "tools": [ { "description": "Converts natural language to Cypher queries", "enabled": true, "name": "query-tool", "type": "text2cypher" } ] } } } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "Created agent": { "value": { "created_by": "user-123", "dbid": "a1b2c3d4", "description": "An agent that queries the database", "enabled": true, "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "is_mcp_enabled": false, "is_private": false, "name": "My Agent", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee", "system_prompt": "", "tools": [ { "config": {}, "description": "Converts natural language to Cypher queries", "enabled": true, "name": "query-tool", "type": "text2cypher" } ] } } }, "schema": { "$ref": "#/components/schemas/AgentDetails" } } }, "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Create an agent", "tags": [ "agents" ] } }, "/organizations/{org_id}/projects/{project_id}/agents/{agent_id}": { "delete": { "description": "Deletes an agent by its ID.", "operationId": "delete-agent", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Agent not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Delete an agent", "tags": [ "agents" ] }, "get": { "description": "Returns the details of a specific agent.", "operationId": "get-agent", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get agent": { "value": { "created_by": "user-123", "dbid": "a1b2c3d4", "description": "An agent that queries the database", "enabled": true, "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "is_mcp_enabled": false, "is_private": false, "name": "My Agent", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee", "system_prompt": "", "tools": [ { "config": {}, "description": "Converts natural language to Cypher queries", "enabled": true, "name": "query-tool", "type": "text2cypher" } ] } } }, "schema": { "$ref": "#/components/schemas/AgentDetails" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Agent not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Get an agent", "tags": [ "agents" ] }, "patch": { "description": "Partially updates an agent. When `tools` is provided it fully replaces the existing tool list.", "operationId": "patch-agent", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Patch agent enabled": { "value": { "enabled": false } }, "Patch agent name": { "value": { "name": "My Renamed Agent" } } } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Patched agent": { "value": { "created_by": "user-123", "dbid": "a1b2c3d4", "description": "An agent that queries the database", "enabled": true, "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "is_mcp_enabled": false, "is_private": false, "name": "My Renamed Agent", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee", "system_prompt": "You are a helpful assistant", "tools": [ { "config": {}, "description": "Converts natural language to Cypher queries", "enabled": true, "name": "query-tool", "type": "text2cypher" } ] } } }, "schema": { "$ref": "#/components/schemas/AgentDetails" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Agent not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Partially update an agent", "tags": [ "agents" ] }, "put": { "description": "Updates an existing agent.", "operationId": "update-agent", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Updated agent": { "value": { "created_by": "user-123", "dbid": "a1b2c3d4", "description": "An updated agent description", "enabled": true, "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "is_mcp_enabled": false, "is_private": false, "name": "My Updated Agent", "organization_id": "c4ea09e5-44b2-418e-9aae-0c98c37d1f38", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee", "system_prompt": "You are a helpful assistant", "tools": [ { "config": {}, "description": "Converts natural language to Cypher queries", "enabled": true, "name": "query-tool", "type": "text2cypher" } ] } } }, "schema": { "$ref": "#/components/schemas/AgentDetails" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Agent not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Update an agent", "tags": [ "agents" ] } }, "/organizations/{org_id}/projects/{project_id}/agents/{agent_id}/invoke": { "post": { "description": "Invokes an agent with the given input. Set `stream: true` to receive output as\nServer-Sent Events. Subject to a 3-minute timeout and per-organization token quota.", "operationId": "invoke-agent", "parameters": [ { "in": "header", "name": "Accept", "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Invoke with message array": { "value": { "input": [ { "content": "What movies are in the database?", "role": "user" } ] } }, "Invoke with streaming": { "value": { "input": "What movies are in the database?", "stream": true } }, "Invoke with string input": { "value": { "input": "What movies are in the database?" } } } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Successful invocation": { "value": { "content": [ { "text": "Here are the movies in the database...", "type": "text" } ], "end_reason": "FINAL_ANSWER_PROVIDED", "role": "assistant", "status": "SUCCESS", "type": "message", "usage": { "request_tokens": 150, "response_tokens": 200, "total_tokens": 350 } } } }, "schema": { "$ref": "#/components/schemas/InvokeAgentResponse" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden. The agent is disabled or private." }, "404": { "description": "Agent or database not found." }, "429": { "description": "Token quota for the organization has been exceeded." }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Invoke an agent", "tags": [ "agents" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments": { "get": { "description": "This endpoint returns a list containing a summary of each of your Fleet Manager deployments. To find out more about a specific deployment, retrieve the details using the GET /deployments/{deploymentId} endpoint.", "operationId": "get-deployments", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Deployment" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized. Cannot access the given organization or project." } }, "security": [ { "oauthToken": [] } ], "summary": "Returns a list of deployments", "tags": [ "deployments" ] }, "post": { "description": "Create a new Fleet Manager deployment.", "operationId": "create-deployment", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "id": { "description": "The ID of the created deployment", "type": "string" } }, "type": "object" } } }, "description": "Created" }, "400": { "description": "Bad request. Can be caused by a name that is too long. The name must be a maximum of 30 characters." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." } }, "security": [ { "oauthToken": [] } ], "summary": "Create a new deployment", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments/{deployment_id}": { "delete": { "description": "Unregister a Fleet Manager deployment.", "operationId": "delete-deployment", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Unregistered" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Unregister a deployment", "tags": [ "deployments" ] }, "get": { "description": "This endpoint returns detailed information about the given Fleet Manager deployment.", "operationId": "get-deployment", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DetailedDeployment" }, { "type": "object" } ] } } }, "description": "OK" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Returns the given deployment", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments/{deployment_id}/databases": { "get": { "description": "This endpoint returns details for the logical databases on the given Fleet Manager deployment.", "operationId": "get-deployment-databases", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Database" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Returns databases for the given deployment", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments/{deployment_id}/servers": { "get": { "description": "This endpoint returns details for the servers on the given Fleet Manager deployment.", "operationId": "get-deployment-servers", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Server" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Returns servers for the given deployment", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments/{deployment_id}/servers/{server_id}/databases": { "get": { "description": "This endpoint returns details for the physical databases on the server on the given Fleet Manager deployment.", "operationId": "get-deployment-server-databases", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "server_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ServerDatabase" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Returns server databases for the given deployment", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/fleet-manager/deployments/{deployment_id}/token": { "delete": { "description": "Delete a Fleet Manager deployment token.", "operationId": "delete-token", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Token deleted" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Delete a deployment token", "tags": [ "deployments" ] }, "patch": { "description": "Create a new Fleet Manager deployment token for a deployment that is already registered.", "operationId": "update-deployment-token", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "token": { "description": "The new token for the given deployment.\n\nThis token should be applied to the deployment through 'call.fleetManagement.registerToken(\"token\")';", "type": "string" } }, "type": "object" } } }, "description": "New token created" }, "400": { "description": "Bad request. Can be caused by a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Update a deployment token", "tags": [ "deployments" ] }, "post": { "description": "Create a Fleet Manager deployment token.", "operationId": "create-deployment-token", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "token": { "description": "Token to register the deployment with Fleet Manager.\n\nThis token should be applied to the deployment through 'call.fleetManagement.registerToken(\"token\")';", "type": "string" } }, "type": "object" } } }, "description": "Token created" }, "400": { "description": "Bad request. Can be caused by the deployment already having a token registered to it or a malformed deployment ID." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Cannot access the given deployment." } }, "security": [ { "oauthToken": [] } ], "summary": "Create a deployment token", "tags": [ "deployments" ] } }, "/organizations/{org_id}/projects/{project_id}/graph-analytics/sessions": { "get": { "description": "Lists sessions visible to the caller, optionally filtered by instance, database, owner, start and end date, with pagination.", "operationId": "list-sessions", "parameters": [ { "in": "query", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "database_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "database_username", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "database_uuid", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "list_only_owned", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include_deleted", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Session list": { "value": { "data": [ { "cloud_provider": "gcp", "created_at": "2026-06-15T14:16:04Z", "created_by": { "database_username": "neo4j", "database_uuid": "abcd1234", "type": "DATABASE" }, "database_id": null, "expiry_date": "2026-06-22T14:16:04Z", "host": "s-d8c78075-6dd3-4-gds.\u003cORCHESTRA\u003e.neo4j.io", "id": "s-d8c78075-6dd3-4", "instance_id": "", "memory": "2GB", "name": "my-session", "project_id": "828b30d5-55d1-421f-8ed6-fc6a7fa4a623", "region": "europe-west1", "status": "Ready", "ttl": "1h0m0s" } ], "errors": [] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "OK. Sessions returned." }, "400": { "description": "Bad Request. The request or a filter is invalid." }, "401": { "description": "Unauthorized. Not authenticated or missing permission." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "List sessions", "tags": [ "graph-analytics" ] }, "post": { "description": "Returns an existing GDS session, or creates one when no session matches the request's name, memory, and console user. A session is either attached to an AuraDB instance/database or standalone.", "operationId": "create-or-get-session", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The request body for creating or getting a GDS session. A session is either attached to an AuraDB instance/database (instance_id and/or database_id) or standalone (created in an explicit cloud_provider/region). These two modes are mutually exclusive.", "oneOf": [ { "@comment": "database_username and database_uuid are accepted for internal callers but intentionally kept out of `properties` so they are not rendered in the generated OpenAPI spec. patternProperties validates them by name/type; additionalProperties:false rejects any other unknown field.", "additionalProperties": false, "anyOf": [ { "properties": { "instance_id": { "description": "The ID of the AuraDB instance to attach the session to.", "example": "i-12345678", "type": "string" } }, "required": [ "instance_id" ] }, { "properties": { "database_id": { "description": "The ID of the AuraDB database to attach the session to (relevant for multi-db instances).", "example": "d-12345678", "type": "string" } }, "required": [ "database_id" ] } ], "description": "Attached to an AuraDB instance/database. Provide at least one of instance_id or database_id. cloud_provider/region must be omitted (derived from the instance).", "example": { "instance_id": "i-12345678", "memory": "4GB", "name": "my-session", "ttl": "4d1h" }, "patternProperties": { "^database_username$": { "type": "string" }, "^database_uuid$": { "type": "string" } }, "properties": { "database_id": { "description": "The ID of the AuraDB database to attach the session to (relevant for multi-db instances).", "example": "d-12345678", "type": "string" }, "instance_id": { "description": "The ID of the AuraDB instance to attach the session to.", "example": "i-12345678", "type": "string" }, "memory": { "description": "The amount of memory to allocate for the session. Must be a valid memory size string (e.g., '2GB', '512MB').", "example": "2GB", "type": "string" }, "name": { "description": "The name of the session.", "example": "my-session", "type": "string" }, "ttl": { "description": "The time-to-live (TTL) for the session. Must be a valid duration string (e.g., '4d1h', '1h', '30m').", "example": "4d1h", "type": "string" } }, "required": [ "name", "memory" ], "title": "Session attached to an AuraDB instance/database", "type": "object" }, { "additionalProperties": false, "description": "Created in an explicit cloud_provider and region, not attached to any AuraDB instance/database.", "example": { "cloud_provider": "gcp", "memory": "2GB", "name": "my-session", "region": "europe-west1", "ttl": "4d1h" }, "properties": { "cloud_provider": { "description": "The cloud provider where the standalone session will be created.", "enum": [ "aws", "gcp", "azure" ], "example": "gcp", "type": "string" }, "memory": { "description": "The amount of memory to allocate for the session. Must be a valid memory size string (e.g., '2GB', '512MB').", "example": "2GB", "type": "string" }, "name": { "description": "The name of the session.", "example": "my-session", "type": "string" }, "region": { "description": "The region where the standalone session will be created (e.g., 'us-east-1', 'europe-west1').", "example": "europe-west1", "type": "string" }, "ttl": { "description": "The time-to-live (TTL) for the session. Must be a valid duration string (e.g., '4d1h', '1h', '30m').", "example": "4d1h", "type": "string" } }, "required": [ "name", "memory", "cloud_provider", "region" ], "title": "Standalone session", "type": "object" } ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Existing standalone session returned": { "value": { "data": { "cloud_provider": "gcp", "created_at": "2026-06-15T14:16:04Z", "created_by": { "console_user_id": "505d0f7d-107b-43c5-81e6-5274e970ecd6", "type": "CONSOLE" }, "database_id": null, "expiry_date": "2026-06-22T14:16:04Z", "host": "s-d8c78075-6dd3-4-gds.\u003cORCHESTRA\u003e.neo4j.io", "id": "s-d8c78075-6dd3-4", "instance_id": "", "memory": "2GB", "name": "my-session", "project_id": "828b30d5-55d1-421f-8ed6-fc6a7fa4a623", "region": "europe-west1", "status": "Ready", "ttl": "1h0m0s" }, "errors": [] } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/SessionResponse" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "OK. Existing session returned." }, "202": { "content": { "application/json": { "examples": { "Attached session creation accepted": { "value": { "data": { "cloud_provider": "gcp", "created_at": "2026-06-15T14:16:04Z", "created_by": { "database_username": "neo4j", "database_uuid": "abcd1234", "type": "DATABASE" }, "database_id": "d-12345678", "expiry_date": "2026-06-22T14:16:04Z", "host": "s-d8c78075-6dd3-4-gds.\u003cORCHESTRA\u003e.neo4j.io", "id": "s-d8c78075-6dd3-4", "instance_id": "i-12345678", "memory": "4GB", "name": "my-session", "project_id": "828b30d5-55d1-421f-8ed6-fc6a7fa4a623", "region": "europe-west1", "status": "Creating", "ttl": "1h0m0s" }, "errors": [] } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/SessionResponse" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "Accepted. Session creation accepted." }, "400": { "description": "Bad Request. The request body is invalid, or the instance/database was not found." }, "401": { "description": "Unauthorized. Not authenticated or missing permission." }, "403": { "description": "Forbidden. The project is not allowed to create sessions." }, "409": { "description": "Conflict. A session already exists with different parameters." }, "413": { "description": "Request Entity Too Large. The request body exceeds the maximum allowed size." }, "415": { "description": "Unsupported Media Type. Content-Type must be application/json." }, "429": { "description": "Too Many Requests. Concurrent session limit reached." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "Create or get a session", "tags": [ "graph-analytics" ] } }, "/organizations/{org_id}/projects/{project_id}/graph-analytics/sessions/sizing": { "post": { "description": "Estimates the memory size of a session from node count, relationship count, property counts, and algorithm categories.", "operationId": "estimate-session-size", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The request body for estimating the memory size of a session from its expected graph dimensions.", "example": { "algorithm_categories": [ "centrality" ], "node_count": 1000, "node_label_count": 2, "node_property_count": 5, "relationship_count": 1000000, "relationship_property_count": 1 }, "not": { "required": [ "algorithm_categories", "algorithms" ] }, "properties": { "algorithm_categories": { "description": "The algorithm categories to be used in the session.", "example": [ "centrality" ], "items": { "enum": [ "centrality", "community-detection", "machine-learning", "node-embedding", "path-finding", "similarity" ], "type": "string" }, "type": "array" }, "algorithms": { "description": "A list of algorithms and their configuration to run estimation against. This field is mutually exclusive with algorithm_categories; only one of the two may be provided.", "example": [ { "config": { "damping_factor": 0.85, "max_iterations": 20 }, "name": "pagerank" } ], "items": { "additionalProperties": false, "properties": { "config": { "additionalProperties": true, "description": "The configuration for the algorithm.", "type": "object" }, "name": { "description": "The name of the algorithm to run estimation against.", "example": "pagerank", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "node_count": { "description": "Number of nodes to be stored in the session.", "example": 1000, "maximum": 1125899906842623, "minimum": 1, "type": "integer" }, "node_label_count": { "description": "Number of node labels.", "example": 2, "maximum": 1125899906842623, "minimum": 0, "type": "integer" }, "node_property_count": { "description": "Number of node properties.", "example": 5, "maximum": 1125899906842623, "minimum": 0, "type": "integer" }, "relationship_count": { "description": "Number of relationships to be stored in the session.", "example": 1000000, "maximum": 1125899906842623, "minimum": 0, "type": "integer" }, "relationship_property_count": { "description": "Number of relationship properties.", "example": 1, "maximum": 1125899906842623, "minimum": 0, "type": "integer" } }, "required": [ "node_count" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Estimated size returned": { "value": { "data": { "estimated_memory": "1.6GB", "recommended_size": "2GB" }, "errors": [] } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/SessionSizeResponse" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "OK. Estimated size returned." }, "400": { "description": "Bad Request. The request is invalid." }, "413": { "description": "Request Entity Too Large. The request body exceeds the maximum allowed size." }, "415": { "description": "Unsupported Media Type. Content-Type must be application/json." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "Estimate session size", "tags": [ "graph-analytics" ] } }, "/organizations/{org_id}/projects/{project_id}/graph-analytics/sessions/{session_id}": { "delete": { "description": "Deletes a single GDS session by its id. The caller must own the session or hold delete permission on the project.", "operationId": "delete-session", "parameters": [ { "in": "query", "name": "database_username", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "database_uuid", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "examples": { "Session deleted": { "value": { "data": { "id": "s-d8c78075-6dd3-4" }, "errors": [] } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/DeleteSessionResponse" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "Accepted. Session deletion accepted." }, "400": { "description": "Bad Request. The request is invalid." }, "401": { "description": "Unauthorized. Not authenticated or missing permission." }, "404": { "description": "Not Found. Session not found." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "Delete session", "tags": [ "graph-analytics" ] }, "get": { "description": "Returns a single GDS session by its id.", "operationId": "get-session", "parameters": [ { "in": "query", "name": "database_username", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "database_uuid", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Session returned": { "value": { "data": { "cloud_provider": "gcp", "created_at": "2026-06-15T14:16:04Z", "created_by": { "database_username": "neo4j", "database_uuid": "abcd1234", "type": "DATABASE" }, "database_id": null, "expiry_date": "2026-06-22T14:16:04Z", "host": "s-d8c78075-6dd3-4-gds.\u003cORCHESTRA\u003e.neo4j.io", "id": "s-d8c78075-6dd3-4", "instance_id": "", "memory": "2GB", "name": "my-session", "project_id": "828b30d5-55d1-421f-8ed6-fc6a7fa4a623", "region": "europe-west1", "status": "Ready", "ttl": "1h0m0s" }, "errors": [] } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/SessionResponse" }, "errors": { "items": { "$ref": "#/components/schemas/GDSError" }, "type": "array" } }, "type": "object" } } }, "description": "OK. Session returned." }, "400": { "description": "Bad Request. The request is invalid." }, "401": { "description": "Unauthorized. Not authenticated or missing permission." }, "404": { "description": "Not Found. Session not found." }, "500": { "description": "Internal Server Error. An unexpected error occurred on the server." } }, "security": [ { "oauthToken": [] } ], "summary": "Get session", "tags": [ "graph-analytics" ] } }, "/organizations/{org_id}/projects/{project_id}/import/jobs": { "post": { "description": "Create a new import job by the specified import model ID, Aura instance ID and optional Aura credentials.\nThe model ID can be found in the URL as such `console-preview.neo4j.io/tools/import/model/\u003cmodel ID\u003e`.", "operationId": "create-import-job", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Created import job": { "value": { "data": { "id": "87d485b4-73fc-4a7f-bb03-720f4672947e" } } } }, "schema": { "$ref": "#/components/schemas/JobIdEnvelope" } } }, "description": "Created" } }, "security": [ { "oauthToken": [] } ], "summary": "Create a new import job", "tags": [ "import-jobs" ] } }, "/organizations/{org_id}/projects/{project_id}/import/jobs/{id}": { "get": { "description": "Retrieves a single job details by its ID.", "operationId": "get-import-job", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "With progress details": { "value": { "data": { "aura_target": { "db_id": "07e49cf5", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee" }, "data_source": { "id": "177216b3-49b9-4e24-a414-a9ecbb448c53", "name": "AWS_POSTGRES_FLIGHTS", "type": "postgresql" }, "id": "87d485b4-73fc-4a7f-bb03-720f4672947e", "import_type": "online", "info": { "cancellation_requested_time": "2025-08-15T13:15:19.655209Z", "completion_time": "2025-08-15T13:15:19Z", "exit_status": { "message": "Cancelled", "state": "Cancelled" }, "last_update_time": "2025-08-18T12:25:53.469873Z", "percentage_complete": 95.23, "progress": { "nodes": [ { "created_constraints": 1, "created_indexes": 0, "created_nodes": 9, "id": "n:1", "labels": [ "AircraftData" ], "processed_rows": 9, "total_rows": 9 } ], "relationships": [ { "created_constraints": 0, "created_indexes": 0, "created_relationships": 255000, "id": "r:8", "processed_rows": 255000, "total_rows": 366733, "type": "TICKET_BELONGS_TO_BOOKING" } ] }, "start_time": "2025-08-15T13:12:51Z", "state": "Completed", "submitted_time": "2025-08-15T13:12:50.499797Z" }, "user_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee" } } }, "Without progress details": { "value": { "data": { "aura_target": { "db_id": "07e49cf5", "project_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee" }, "data_source": { "id": "177216b3-49b9-4e24-a414-a9ecbb448c53", "name": "AWS_POSTGRES_FLIGHTS", "type": "postgresql" }, "id": "87d485b4-73fc-4a7f-bb03-720f4672947e", "import_type": "online", "info": { "cancellation_requested_time": "2025-08-15T13:15:19.655209Z", "completion_time": "2025-08-15T13:15:19Z", "exit_status": { "message": "Cancelled", "state": "Cancelled" }, "last_update_time": "2025-08-18T12:25:53.469873Z", "percentage_complete": 95.23, "start_time": "2025-08-15T13:12:51Z", "state": "Completed", "submitted_time": "2025-08-15T13:12:50.499797Z" }, "user_id": "f607bebe-0cc0-4166-b60c-b4eed69ee7ee" } } } }, "schema": { "$ref": "#/components/schemas/ImportJobEnvelope" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Get job by ID", "tags": [ "import-jobs" ] } }, "/organizations/{org_id}/projects/{project_id}/import/jobs/{id}/cancellation": { "post": { "description": "Cancel an existing import job.", "operationId": "cancel-import-job", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Cancelled import job": { "value": { "data": { "id": "87d485b4-73fc-4a7f-bb03-720f4672947e" } } } }, "schema": { "$ref": "#/components/schemas/JobIdEnvelope" } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Cancel an import job", "tags": [ "import-jobs" ] } }, "/organizations/{org_id}/projects/{project_id}/instances": { "get": { "description": "Get instances for a given project.", "operationId": "GET/v2beta1/organizations/:org_id/projects/:project_id/instances", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List of instances": { "value": { "data": [ { "cloud_provider": "gcp", "created_at": "2024-01-15T10:30:00Z", "id": "2f49c2b3", "name": "Production" }, { "cloud_provider": "aws", "created_at": "2024-02-20T14:00:00Z", "id": "b51dc964", "name": "Instance01" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/InstanceSummary" }, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Project not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Get instances for a given project", "tags": [ "instances" ] }, "post": { "description": "Create an Instance.", "operationId": "POST/v2beta1/organizations/:org_id/projects/:project_id/instances", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Create a Business Critical instance with multi-database": { "value": { "cloud_provider": "aws", "memory": "16GB", "multi_database": true, "name": "Instance03", "region": "us-east-1", "type": "business-critical" } }, "Create a Free instance": { "value": { "cloud_provider": "gcp", "name": "Instance05", "region": "europe-west1", "type": "free" } }, "Create a Professional instance": { "value": { "cloud_provider": "gcp", "memory": "4GB", "name": "Instance04", "region": "europe-west1", "type": "professional", "vector_optimized": true } }, "Create a Virtual Dedicated Cloud instance": { "value": { "cloud_provider": "gcp", "memory": "4GB", "name": "Instance01", "region": "europe-west1", "type": "virtual-dedicated-cloud" } }, "Create an instance with Graph Analytics": { "value": { "cloud_provider": "gcp", "graph_analytics": "serverless", "memory": "8GB", "name": "Instance02", "region": "europe-west1", "type": "virtual-dedicated-cloud" } } } } } }, "responses": { "202": { "content": { "application/json": { "examples": { "Instance being created": { "value": { "data": { "cloud_provider": "gcp", "connection_url": "neo4j+s://db1d1234.databases.neo4j.io", "created_at": "2024-01-15T10:30:00Z", "id": "db1d1234", "legacy_status": "creating", "memory": "4GB", "multi_database": true, "name": "Instance01", "password": "letMeIn123!", "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "region": "europe-west1", "storage": "16GB", "type": "enterprise-db", "username": "neo4j", "vector_optimized": false } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/CreateInstanceResponse" } }, "required": [ "data" ], "type": "object" } } }, "description": "Accepted" }, "400": { "description": "Bad request. The request body is malformed or invalid." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Project not found." }, "405": { "description": "Creating Instances is not permitted at this time." } }, "security": [ { "oauthToken": [] } ], "summary": "Create an Instance", "tags": [ "instances" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}": { "delete": { "description": "Delete Instance by ID.", "operationId": "DELETE/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "examples": { "Instance being deleted": { "value": { "data": { "cloud_provider": "gcp", "graph_analytics": "serverless", "id": "2f49c2b3", "legacy_status": "destroying", "memory": "4GB", "multi_database": true, "name": "Production", "region": "europe-west1", "storage": "16GB", "type": "enterprise-db", "vector_optimized": false } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/InstanceDetails" } }, "required": [ "data" ], "type": "object" } } }, "description": "Accepted. Instance is being deleted." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Instance not found." }, "409": { "description": "Conflict. Another operation is in progress on this Instance." } }, "security": [ { "oauthToken": [] } ], "summary": "Delete Instance by ID", "tags": [ "instances" ] }, "get": { "description": "Get Instance by ID.", "operationId": "GET/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Instance details": { "value": { "data": { "cloud_provider": "gcp", "graph_analytics": "serverless", "id": "2f49c2b3", "legacy_status": "running", "memory": "4GB", "multi_database": true, "name": "Production", "region": "europe-west1", "storage": "16GB", "type": "enterprise-db", "vector_optimized": false } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/InstanceDetails" } }, "required": [ "data" ], "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Instance not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Get Instance by ID", "tags": [ "instances" ] }, "patch": { "description": "Update an Instance's configuration \u0026 details.", "operationId": "PATCH/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The request body for updating an Instance", "properties": { "memory": { "description": "The desired memory for the Instance", "example": "16GB", "type": "string" }, "storage": { "description": "The desired storage for the Instance", "example": "32GB", "type": "string" } }, "type": "object" } } } }, "responses": { "202": { "content": { "application/json": { "examples": { "Updated Instance details": { "value": { "data": { "cloud_provider": "gcp", "graph_analytics": "serverless", "id": "2f49c2b3", "legacy_status": "resizing", "memory": "16GB", "multi_database": true, "name": "Production", "region": "europe-west1", "storage": "32GB", "type": "enterprise-db", "vector_optimized": false } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/InstanceDetails" } }, "required": [ "data" ], "type": "object" } } }, "description": "Accepted" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Instance not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Update Instance by ID", "tags": [ "instances" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/databases": { "get": { "description": "List Databases for a given Instance.", "operationId": "GET/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id/databases", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List Databases": { "value": { "data": [ { "id": "db-1234" }, { "id": "db-5678" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DatabaseSummary" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Caller does not have access to the given Instance." }, "404": { "description": "Not found. The given Instance does not exist." } }, "security": [ { "oauthToken": [] } ], "summary": "List Databases for a given Instance", "tags": [ "databases" ] }, "post": { "description": "Create a Database in a given Instance.", "operationId": "POST/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id/databases", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "examples": { "Create Database": { "value": { "data": { "id": "db-1234" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/DatabaseSummary" } }, "type": "object" } } }, "description": "Created" }, "400": { "description": "Bad request. The request body is malformed." }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "403": { "description": "Forbidden. Caller does not have access to the given Instance." }, "404": { "description": "Not found. The given Instance does not exist." }, "409": { "description": "Conflict. The Add Database action is currently unavailable for this Instance." }, "422": { "description": "Unprocessable entity. Can be caused by a failed request body validation,\nthe database limit for the Instance being reached, or invalid clone parameters." } }, "security": [ { "oauthToken": [] } ], "summary": "Create a Database in a given Instance", "tags": [ "databases" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/databases/{database_id}": { "delete": { "description": "Delete Database by ID.", "operationId": "DELETE/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id/databases/:database_id", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "examples": { "Delete Database": { "value": { "data": { "id": "db-1234" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/DatabaseSummary" } }, "type": "object" } } }, "description": "Accepted" }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "404": { "description": "Not found. The given Instance or Database does not exist." }, "409": { "description": "Conflict. The Delete Database action is currently unavailable for this Database." } }, "security": [ { "oauthToken": [] } ], "summary": "Delete Database by ID", "tags": [ "databases" ] }, "get": { "description": "Get Database by ID.", "operationId": "GET/v2beta1/organizations/:org_id/projects/:project_id/instances/:instance_id/databases/:database_id", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get Database": { "value": { "data": { "id": "db-1234" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/DatabaseSummary" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized. Cannot access the given organization or project." }, "404": { "description": "Not found. The given Instance or Database does not exist." } }, "security": [ { "oauthToken": [] } ], "summary": "Get Database by ID", "tags": [ "databases" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/databases/{database_id}/backups": { "get": { "description": "Returns a list of Backups for the given Database.", "operationId": "list-instance-database-backups", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List Backups": { "value": { "data": [ { "exportable": true, "id": "backup-5678", "status": "Completed", "timestamp": "2024-01-02T00:00:00Z" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DatabaseBackup" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized. Cannot access the given Organization or Project." }, "403": { "description": "Forbidden. Caller does not have access to the given Database." }, "404": { "description": "Not found. The given Instance or Database does not exist." } }, "security": [ { "oauthToken": [] } ], "summary": "List Backups for a given Database", "tags": [ "backups" ] }, "post": { "description": "Requests a new Backup of the given Database.\n\nThe Backup is taken asynchronously. The response returns a `backup_id` which can be used to poll the status of the Backup.", "operationId": "create-instance-database-backup", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "examples": { "Take Backup": { "value": { "data": { "id": "backup-5678" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/CreateDatabaseBackupResponse" } }, "type": "object" } } }, "description": "Accepted" }, "401": { "description": "Unauthorized. Cannot access the given Organization or Project." }, "403": { "description": "Forbidden. Caller does not have access to the given Database." }, "404": { "description": "Not found. The given Instance or Database does not exist." }, "409": { "description": "Conflict. The Database is suspended, not running, has a Backup already in progress, or has an ongoing operation." } }, "security": [ { "oauthToken": [] } ], "summary": "Take a Backup of a given Database", "tags": [ "backups" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/databases/{database_id}/backups/{backup_id}": { "get": { "description": "Returns details of a specific Backup of the given Database.", "operationId": "get-instance-database-backup", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "backup_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get Backup": { "value": { "data": { "exportable": true, "id": "backup-5678", "status": "Completed", "timestamp": "2024-01-02T00:00:00Z" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/DatabaseBackup" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized. Cannot access the given Organization or Project." }, "403": { "description": "Forbidden. Caller does not have access to the given Backup." }, "404": { "description": "Not found. The given Instance, Database, or Backup does not exist." } }, "security": [ { "oauthToken": [] } ], "summary": "Get a Database Backup by ID", "tags": [ "backups" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/databases/{database_id}/restore": { "post": { "description": "Restores the given Database from a Backup.\n\nThis is only supported for Multi Database Instances. The restore is performed asynchronously; you can poll the Database details using the GET endpoint to track its progress.", "operationId": "restore-instance-database", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "database_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "The request body for restoring a Database from a Backup", "properties": { "id": { "description": "The ID of the Backup to restore the Database from", "example": "backup-5678", "type": "string" } }, "required": [ "id" ], "type": "object" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad request. The request body is malformed." }, "401": { "description": "Unauthorized. Cannot access the given Organization or Project." }, "403": { "description": "Forbidden. Caller does not have access to the given Database." }, "404": { "description": "Not found. The given Instance, Database, or backup does not exist." }, "409": { "description": "Conflict. The Database is suspended, not running, has an ongoing operation, or the backup is not in a completed state." }, "422": { "description": "Unprocessable entity. Restore is only supported for Multi Database Instances; single-database Instances are not supported by this endpoint." } }, "security": [ { "oauthToken": [] } ], "summary": "Restore a Database from a Backup", "tags": [ "backups" ] } }, "/organizations/{org_id}/projects/{project_id}/instances/{instance_id}/ip-filters": { "get": { "description": "Returns the IP filter with its status applied to an instance, if present.", "operationId": "get-instance-ip-filters", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "IP filter with Status": { "value": { "allow_list": [ { "address": "192.168.1.1", "description": "Office Network", "prefix_len": 24 } ], "filtered_entities": { "instances": [ "some-instance-id" ], "organizations": [], "projects": [] }, "filtering_disabled": false, "id": 12345678, "name": "My IP filter", "organization_id": "example-org-id", "status": "ACTIVE" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/IpFilter" }, { "properties": { "status": { "description": "The status of the IP filter on the Instance", "enum": [ "UNKNOWN", "SUBMITTED", "ACTIVE", "DELETED", "ERROR" ], "type": "string" } }, "type": "object" } ] } } }, "description": "OK" } }, "security": [ { "oauthToken": [] } ], "summary": "Returns a list of IP filters for the organization", "tags": [ "instances" ] } }, "/organizations/{org_id}/projects/{project_id}/users": { "get": { "description": "Returns a list of all users in an Aura Project.\nRequires the caller to be a project admin.", "operationId": "list-project-users", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List project users": { "value": { "data": [ { "email": "wiley.c@example.com", "project_roles": [ "project-admin" ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectUser" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Project not found." } }, "security": [ { "oauthToken": [] } ], "summary": "List all users in a project", "tags": [ "projects", "users" ] }, "post": { "description": "Adds a new user to an Aura Project.\nRequires the caller to be a project admin.", "operationId": "add-project-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Add user to project with project-admin role": { "value": { "project_roles": [ "project-admin" ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } } }, "schema": { "additionalProperties": false, "description": "Request body for adding a user to a project.", "properties": { "project_roles": { "description": "The role to assign to the user.\nExactly one role must be provided.", "items": { "enum": [ "project-admin", "project-member", "project-viewer", "project-metrics-integration-reader" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "user_id": { "description": "The UUID of the user to add to the project.", "format": "uuid", "type": "string" } }, "required": [ "user_id", "project_roles" ], "type": "object" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad request. Invalid role or validation error." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not a project admin." }, "404": { "description": "User or project not found, or user not in organization." }, "409": { "description": "User already in project." } }, "security": [ { "oauthToken": [] } ], "summary": "Add a user to a project", "tags": [ "projects", "users" ] } }, "/organizations/{org_id}/projects/{project_id}/users/{user_id}": { "delete": { "description": "Removes a user from an Aura Project.\nRequires the caller to be a project admin.", "operationId": "delete-project-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not a project admin." }, "404": { "description": "User or project not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Remove a user from a project", "tags": [ "projects", "users" ] }, "patch": { "description": "Updates the role of a user in an Aura Project.\nRequires the caller to be a project admin.\n\nA user can only be assigned a single project role at a time.", "operationId": "update-project-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Update user role to project-admin": { "value": { "project_roles": [ "project-admin" ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a project user's role.", "properties": { "project_roles": { "description": "The role to assign to the user.\nExactly one role must be provided.", "items": { "enum": [ "project-admin", "project-member", "project-viewer", "project-metrics-integration-reader" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "project_roles" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Updated project user": { "value": { "data": { "email": "wiley.c@example.com", "project_roles": [ "project-admin" ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/ProjectUser" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request. Invalid role or validation error." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not a project admin." }, "404": { "description": "User or project not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Update a project user's role", "tags": [ "projects", "users" ] } }, "/organizations/{org_id}/projects/{project_id}/virtual-graphs": { "get": { "description": "Lists Virtual Graph instances in the specified project, newest first. Soft-deleted instances are omitted. Results are cursor-paginated: pass page_limit to size the page and the returned links.next as page_token to fetch the next page.", "operationId": "list-virtual-graphs", "parameters": [ { "in": "query", "name": "page_limit", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_token", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List virtual graphs": { "value": { "data": [ { "bolt_url": "neo4j+s://ge82059a.graph-engine.neo4j.io", "cloud_provider": "gcp", "created_at": "2026-06-09T10:15:00Z", "data_source_id": "ds-abc123", "data_source_type": "databricks-pat", "error_detail": "", "id": "ge82059a", "memory": "4Gi", "name": "sales-analytics", "region": "europe-west1", "status": "running" } ], "links": { "first": "https://api.neo4j.io/v2beta1/organizations/56c01200-de7a-4f1d-ac06-b893c3b5e284/projects/828b30d5-55d1-421f-8ed6-fc6a7fa4a623/virtual-graphs?page_limit=100", "next": null, "self": "https://api.neo4j.io/v2beta1/organizations/56c01200-de7a-4f1d-ac06-b893c3b5e284/projects/828b30d5-55d1-421f-8ed6-fc6a7fa4a623/virtual-graphs?page_limit=100" } } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/VirtualGraph" }, "type": "array" }, "links": { "description": "Cursor-pagination links.", "properties": { "first": { "description": "URL of the first page.", "type": "string" }, "next": { "description": "URL of the next page, or null on the last page.", "type": [ "string", "null" ] }, "self": { "description": "URL of the current page.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "List virtual graphs", "tags": [ "virtual-graphs" ] }, "post": { "description": "Creates a Virtual Graph instance from an existing data source and data model. Provisioning completes asynchronously; the response returns immediately with status creating and a Location header pointing at the new instance (its GET endpoint).\n\nRequires the `enable-graph-engine` feature flag for the organization and write access to the project (`namespace-member` or `namespace-admin`).", "operationId": "create-virtual-graph", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for creating a Virtual Graph from an existing data source and data model.", "properties": { "cloud_provider": { "description": "Cloud provider for deployment.", "enum": [ "gcp", "aws", "azure" ], "type": "string" }, "data_source_id": { "description": "ID of a data source created in Data Importer (for example a Databricks or Snowflake connector).", "type": "string" }, "import_model_id": { "description": "ID of a graph data model stored in Data Importer. The model is fetched on the caller's behalf to build the Virtual Graph.", "type": "string" }, "maximum_bytes_billed": { "description": "Optional. Per-query bytes-billed cap for BigQuery data sources; ignored for other source types.", "format": "int64", "type": "integer" }, "memory": { "description": "Optional. Memory allocation (for example 4Gi). Must be one of the values from GET …/virtual-graphs/allowed-configs.", "type": "string" }, "name": { "description": "Display name for the Virtual Graph.", "maxLength": 30, "type": "string" }, "region": { "description": "Cloud region for deployment (for example europe-west1).", "type": "string" } }, "required": [ "data_source_id", "import_model_id", "name", "cloud_provider", "region" ], "type": "object" } } } }, "responses": { "202": { "content": { "application/json": { "examples": { "Created virtual graph": { "value": { "data": { "bolt_url": "neo4j+s://ge82059a.graph-engine.neo4j.io", "cloud_provider": "gcp", "created_at": "2026-06-09T10:15:00Z", "data_source_id": "ds-abc123", "data_source_type": "databricks-pat", "error_detail": "", "id": "ge82059a", "memory": "4Gi", "name": "sales-analytics", "plain_password": "generated-password-only-shown-once", "region": "europe-west1", "status": "creating" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/VirtualGraphCreateResponse" } }, "type": "object" } } }, "description": "Accepted. Provisioning has started." }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden. Virtual Graphs may be disabled for this organization or the caller lacks project write access." }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Create a virtual graph", "tags": [ "virtual-graphs" ] } }, "/organizations/{org_id}/projects/{project_id}/virtual-graphs/allowed-configs": { "get": { "description": "Returns the selectable memory configurations and the default for Virtual Graph instances in the caller's project.", "operationId": "get-virtual-graph-allowed-configs", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Allowed configs": { "value": { "data": { "configs": [ { "memory": "4Gi" }, { "memory": "8Gi" } ], "default_memory": "4Gi" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/VirtualGraphAllowedConfigs" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Get allowed virtual graph configurations", "tags": [ "virtual-graphs" ] } }, "/organizations/{org_id}/projects/{project_id}/virtual-graphs/{id}": { "delete": { "description": "Deletes a Virtual Graph instance from the project. Deletion completes asynchronously.", "operationId": "delete-virtual-graph", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. Deletion is applied asynchronously." }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Delete a virtual graph", "tags": [ "virtual-graphs" ] }, "get": { "description": "Returns a single Virtual Graph instance by ID in the caller's project.", "operationId": "get-virtual-graph", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get virtual graph": { "value": { "data": { "bolt_url": "neo4j+s://ge82059a.graph-engine.neo4j.io", "cloud_provider": "gcp", "created_at": "2026-06-09T10:15:00Z", "data_source_id": "ds-abc123", "data_source_type": "databricks-pat", "error_detail": "", "id": "ge82059a", "memory": "4Gi", "name": "sales-analytics", "region": "europe-west1", "status": "running" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/VirtualGraph" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Virtual graph not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Get a virtual graph", "tags": [ "virtual-graphs" ] }, "patch": { "description": "Renames a Virtual Graph instance, resizes its memory allocation, and/or updates its graph model schema.", "operationId": "update-virtual-graph", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Partial update for a Virtual Graph instance.", "properties": { "import_model_id": { "description": "ID of a graph data model stored in Data Importer. When provided, the Virtual Graph's graph model schema is updated from this model.", "type": "string" }, "memory": { "description": "New memory allocation (for example 8Gi). Must be one of the values from GET …/virtual-graphs/allowed-configs.", "type": "string" }, "name": { "description": "New display name.", "maxLength": 30, "minLength": 1, "type": "string" } }, "type": "object" } } } }, "responses": { "202": { "description": "Accepted. The update is applied asynchronously." }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Virtual graph not found" }, "500": { "description": "Internal server error" } }, "security": [ { "oauthToken": [] } ], "summary": "Update a virtual graph", "tags": [ "virtual-graphs" ] } }, "/organizations/{org_id}/users": { "get": { "description": "Returns a list of all users in an Aura Organization.\nRequires the caller to be an organization admin.", "operationId": "list-organization-users", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "List organization users": { "value": { "data": [ { "email": "wiley.c@example.com", "exempt_from_automatic_removal": false, "last_activity_at": "2026-04-30T10:41:00.000000Z", "mfa_enrolled_methods": [ { "enrolled_at": "2025-06-15T12:00:00.000000Z", "id": "totp" } ], "mfa_enrollment_status": "enrolled", "organization_roles": [ "organization-admin" ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } ] } } }, "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationUser" }, "type": "array" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not an organization admin." }, "404": { "description": "Organization not found." } }, "security": [ { "oauthToken": [] } ], "summary": "List all users in an organization", "tags": [ "organizations", "users" ] } }, "/organizations/{org_id}/users/{user_id}": { "delete": { "description": "Remove an Aura User from an Aura Organization.", "operationId": "delete-organization-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad request. User can not be removed." }, "401": { "description": "Unauthorized. Do not have required permissions in organization." }, "403": { "description": "Forbidden." }, "404": { "description": "User not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Remove a user from an organization", "tags": [ "organizations", "users" ] }, "get": { "description": "Returns detailed information about a user in an Aura Organization,\nincluding their organization roles, project memberships, and MFA status.\nRequires the caller to be an organization admin.", "operationId": "get-organization-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Get organization user": { "value": { "data": { "email": "wiley.c@example.com", "exempt_from_automatic_removal": false, "last_activity_at": "2026-04-30T10:41:00.000000Z", "mfa_enrolled_methods": [ { "enrolled_at": "2025-06-15T12:00:00.000000Z", "id": "totp" } ], "mfa_enrollment_status": "enrolled", "organization_roles": [ "organization-member" ], "projects": [ { "id": "89fcc404-a509-488e-a3a4-53d3e80b99b7", "name": "My Project", "project_roles": [ "project-admin" ] } ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationUserDetails" } }, "type": "object" } } }, "description": "OK" }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden. Caller is not an organization admin." }, "404": { "description": "User not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Get an organization user", "tags": [ "organizations", "users" ] }, "patch": { "description": "Updates a user's role in an organization.", "operationId": "update-organization-user", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Update user role to organization-admin": { "value": { "organization_roles": [ "organization-admin" ] } } }, "schema": { "additionalProperties": false, "description": "The request body for updating an organization user's role.", "properties": { "organization_roles": { "description": "The organization role to assign to the user.\nExactly one role must be provided.", "items": { "enum": [ "organization-owner", "organization-admin", "organization-member" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "organization_roles" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Update organization user": { "value": { "data": { "email": "wiley.c@example.com", "exempt_from_automatic_removal": false, "last_activity_at": "2026-04-30T10:41:00.000000Z", "mfa_enrolled_methods": [ { "enrolled_at": "2025-06-15T12:00:00.000000Z", "id": "totp" } ], "mfa_enrollment_status": "enrolled", "organization_roles": [ "organization-member" ], "projects": [ { "id": "89fcc404-a509-488e-a3a4-53d3e80b99b7", "name": "My Project", "project_roles": [ "project-admin" ] } ], "user_id": "9aa289f6-1ccf-57c8-bc90-a0c3cecc82ac" } } } }, "schema": { "properties": { "data": { "$ref": "#/components/schemas/OrganizationUserDetails" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad request. User's role cannot be updated." }, "401": { "description": "Unauthorized. Do not have required permissions in organization." }, "403": { "description": "Forbidden." }, "404": { "description": "User not found." } }, "security": [ { "oauthToken": [] } ], "summary": "Updates a user's role in an organization", "tags": [ "organizations", "users" ] } } }, "servers": [ { "description": "Aura API v2beta1", "url": "https://api.neo4j.io/v2beta1" } ], "tags": [ { "description": "Relates to Aura Organizations.", "name": "organizations" }, { "description": "Relates to Aura Projects.", "name": "projects" }, { "description": "Relates to Aura Instances.", "name": "instances" }, { "description": "Relates to Aura Databases.", "name": "databases" }, { "description": "Relates to Aura Database Backups.", "name": "backups" }, { "description": "Relates to Aura IP Filtering Rules.", "name": "ip-filters" }, { "description": "Relates to Import Jobs.", "name": "import-jobs" }, { "description": "Relates to Fleet Manager Deployments", "name": "deployments" }, { "description": "Relates to Activity Feed.", "name": "activity-feed" }, { "description": "Relates to Billing.", "name": "billing" }, { "description": "Relates to Aura Agents.", "name": "agents" }, { "description": "Relates to Aura Users.", "name": "users" }, { "description": "Relates to Graph Analytics.", "name": "graph-analytics" } ] }