Skip to content
Proud to collaborate with Microsoft for Startups

data.network.profile.update ​

Update a NetworkProfile (name, description, type, default, config)

Apply a partial update to a NetworkProfile.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_profile_uuiduuidYes—UUID of the NetworkProfile to update
namestringNo—New name
descriptionstringNo—New description
profile_typestringNo—NetworkProfileType value
is_defaultbooleanNo—Toggle org default flag
configdictNo—Profile config; UUIDs only
actorstringNo—Caller initiating the update

Output Schema ​

FieldTypeRequiredDefaultDescription
network_profile_uuiduuidYes—UUID of the updated profile
updated_fieldslistYes—Names of fields that were applied
updated_atstringYes—ISO-8601 timestamp
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeUpdate profile
completedNoYesYes—Updated
failedNoYesNo—Update failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
updatedSUCCESSUpdate a NetworkProfile (name, description, type, default, config)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "data.network.profile.update",
  "initial_data": {
    "organization_uuid": "value",
    "network_profile_uuid": "value"
  }
}