Skip to content
Proud to collaborate with Microsoft for Startups

neon.projects.update ​

Update a Neon project's name or settings (PATCH)

Updates a Neon project's name (or other mutable settings) via PATCH.

Neon's PATCH /projects/{id} is synchronous — it returns the updated project immediately with no operations[] array to poll. Calling PATCH with an unchanged name is idempotent.

Inputs:

  • neon_project_id: Neon provider project ID (required)
  • name: new project name (optional)

Outputs (terminal state_data):

  • neon_project_id: str — Neon provider project ID
  • name: str — confirmed project name after update
  • provider_metadata: dict — full Neon project object from the response

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 provider project ID
namestringNo—New project name

Output Schema ​

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