Skip to content
Proud to collaborate with Microsoft for Startups

neon.databases.delete ​

Delete a database from a Neon branch

Delete a database from a Neon branch.

Inputs:

  • neon_project_id: Neon project ID (required).
  • neon_branch_id: Neon branch ID (required).
  • db_name: name of the database to delete (required).

Outputs (terminal state_data):

  • neon_project_id: str
  • neon_branch_id: str
  • db_name: str
  • deleted: bool — always true on success

Idempotency: HTTP 404 (database already gone) is treated as success. Compensation: Use neon.databases.create to recreate. Plugin required: context.get_plugin("neon") must expose .api_token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Cloud connection holding the Neon credential
neon_project_idstringYes—Neon project ID
neon_branch_idstringYes—Neon branch ID
db_namestringYes—Name of the database to delete

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
neon_project_idstringNo——
neon_branch_idstringNo——
db_namestringNo——
deletedbooleanNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "neon.databases.delete",
  "initial_data": {
    "neon_project_id": "value",
    "neon_branch_id": "value",
    "db_name": "value"
  }
}