Skip to content
Proud to collaborate with Microsoft for Startups

neon.projects.delete ​

Delete a Neon project permanently by provider ID

Delete a Neon project permanently by its provider (Neon) project ID.

Inputs:

  • neon_project_id: Neon project ID to delete (required).

Outputs (terminal state_data):

  • neon_project_id: str — the deleted project ID
  • deleted: bool — true on success (and on idempotent 404 already-gone)

Idempotency / error policy:

  • HTTP 404 → treated as idempotent success (project already gone).
  • HTTP 403 → WorkflowNotRetryableError (forbidden / not permitted).
  • other 4xx → WorkflowNotRetryableError (via _common.raise_for_neon_status).
  • 5xx / timeouts → propagate so the engine retries.

Compensation: none — deletion is destructive and irreversible. 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 to delete

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
neon_project_idstringNo——
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.projects.delete",
  "initial_data": {
    "neon_project_id": "value"
  }
}