Skip to main content

update-cloudflow-connection 

dci update-cloudflow-connection <connectionId> [body]

Partially updates a connection. All fields are optional. At most one of gcpConfig or awsConfig may be set per request.

  • connectionId — Identifier of the resource.

Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.

Confirmation required

A connection change can disable every flow that depends on it, so the CLI classifies this command as destructive: interactive terminals show a confirmation prompt, scripts must pass --yes, and --dry-run prints a local preview without sending anything — see the CLI guide's Destructive commands.

Partial update

Every field is optional; omitted fields keep their current value. At most one of gcpConfig or awsConfig may be set per request.

Examples​

# Preview disabling a connection without sending anything.
dci update-cloudflow-connection <connection-id> --dry-run enabled: false
# Disable it for real in a script (flows that use it stop being able to act).
dci update-cloudflow-connection <connection-id> --yes enabled: false
# Rename and describe a connection.
dci update-cloudflow-connection <connection-id> --yes name: "AWS production", description: "Managed by FinOps"
# Add a collaborator, with the body read from a file.
dci update-cloudflow-connection <connection-id> --yes < collaborators.json
# collaborators.json
{"collaborators": [{"email": "[email protected]", "role": "editor"}, {"email": "[email protected]", "role": "owner"}]}

Request​

Content-Type: application/json

FieldTypeRequiredDescription
namestring
descriptionstring
gcpConfigobjectGCP connection configuration. Server-owned fields (status, deploymentCommand) are excluded.
gcpConfig.organizationIdstring
gcpConfig.folderIdstring
gcpConfig.projectIdstring
gcpConfig.levelstringOne of: "organization", "folder", "project".
gcpConfig.serviceAccountNamestring
gcpConfig.predefinedRolesarray of string
gcpConfig.customRoleobject
gcpConfig.customRole.roleIdstring
gcpConfig.customRole.permissionsarray of string
gcpConfig.infraManagerProjectstring
gcpConfig.infraManagerLocationstring
gcpConfig.infraManagerServiceAccountstring
awsConfigobjectAWS connection configuration. Server-owned fields (context[].status, context[].nextStackOperation, stackSet) are excluded.
awsConfig.contextarray of object
awsConfig.context[].accountIdstring
awsConfig.context[].regionsarray of string
awsConfig.roleNamestring
awsConfig.permissionsobject
awsConfig.managementAccountstring
awsConfig.organizationRootIdstring
awsConfig.scopeTargetedOrganizationalUnitIdsarray of string
awsConfig.scopeExplicitAccountIdsarray of string
awsConfig.scopeExcludedAccountIdsarray of string
awsConfig.scopeManagementAccountExplicitInScopeboolean
collaboratorsarray of object
collaborators[].emailstring (email)
collaborators[].rolestringOne of: "owner", "editor", "user".
enabledbooleanSet to false to disable the connection, true to re-enable it.
Raw JSON schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "gcpConfig": {
      "type": "object",
      "description": "GCP connection configuration. Server-owned fields (status, deploymentCommand) are excluded.",
      "properties": {
        "organizationId": {
          "type": "string"
        },
        "folderId": {
          "type": "string"
        },
        "projectId": {
          "type": "string"
        },
        "level": {
          "type": "string",
          "enum": [
            "organization",
            "folder",
            "project"
          ]
        },
        "serviceAccountName": {
          "type": "string"
        },
        "predefinedRoles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "customRole": {
          "type": "object",
          "properties": {
            "roleId": {
              "type": "string"
            },
            "permissions": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "infraManagerProject": {
          "type": "string"
        },
        "infraManagerLocation": {
          "type": "string"
        },
        "infraManagerServiceAccount": {
          "type": "string"
        }
      }
    },
    "awsConfig": {
      "type": "object",
      "description": "AWS connection configuration. Server-owned fields (context[].status, context[].nextStackOperation, stackSet) are excluded.",
      "properties": {
        "context": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "accountId": {
                "type": "string"
              },
              "regions": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        },
        "roleName": {
          "type": "string"
        },
        "permissions": {
          "type": "object"
        },
        "managementAccount": {
          "type": "string"
        },
        "organizationRootId": {
          "type": "string"
        },
        "scopeTargetedOrganizationalUnitIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scopeExplicitAccountIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scopeExcludedAccountIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scopeManagementAccountExplicitInScope": {
          "type": "boolean"
        }
      }
    },
    "collaborators": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "editor",
              "user"
            ]
          }
        }
      }
    },
    "enabled": {
      "type": "boolean",
      "description": "Set to false to disable the connection, true to re-enable it."
    }
  }
}

Output​

OK

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
connectionIdstringUnique identifier for the connection.
namestring
descriptionstring
gcpConfigobjectGCP connection configuration. Server-owned fields (status, deploymentCommand) are excluded.
gcpConfig.statusstringServer-managed GCP config status.
gcpConfig.deploymentCommandstringGenerated deployment command.
gcpConfig.organizationIdstring
gcpConfig.folderIdstring
gcpConfig.projectIdstring
gcpConfig.levelstringOne of: "organization", "folder", "project".
gcpConfig.serviceAccountNamestring
gcpConfig.predefinedRolesarray of string
gcpConfig.customRoleobject
gcpConfig.customRole.roleIdstring
gcpConfig.customRole.permissionsarray of string
gcpConfig.infraManagerProjectstring
gcpConfig.infraManagerLocationstring
gcpConfig.infraManagerServiceAccountstring
awsConfigobjectAWS connection configuration. Server-owned fields (context[].status, context[].nextStackOperation, stackSet) are excluded.
awsConfig.contextarray of object
awsConfig.context[].accountIdstring
awsConfig.context[].regionsarray of string
awsConfig.roleNamestring
awsConfig.permissionsobject
awsConfig.managementAccountstring
awsConfig.organizationRootIdstring
awsConfig.scopeTargetedOrganizationalUnitIdsarray of string
awsConfig.scopeExplicitAccountIdsarray of string
awsConfig.scopeExcludedAccountIdsarray of string
awsConfig.scopeManagementAccountExplicitInScopeboolean
collaboratorsarray of object
collaborators[].emailstring (email)
collaborators[].rolestringOne of: "owner", "editor", "user".
enabledbooleanfalse when the connection is disabled.
statusstringOverall connection status.
createdAtstring (date-time)
updatedAtstring (date-time)
Raw JSON schema
{
  "type": "object",
  "description": "A cloud provider connection used in CloudFlow workflows.",
  "properties": {
    "connectionId": {
      "type": "string",
      "description": "Unique identifier for the connection."
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "gcpConfig": {
      "allOf": [
        {
          "type": "object",
          "description": "GCP connection configuration. Server-owned fields (status, deploymentCommand) are excluded.",
          "properties": {
            "organizationId": {
              "type": "string"
            },
            "folderId": {
              "type": "string"
            },
            "projectId": {
              "type": "string"
            },
            "level": {
              "type": "string",
              "enum": [
                "organization",
                "folder",
                "project"
              ]
            },
            "serviceAccountName": {
              "type": "string"
            },
            "predefinedRoles": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "customRole": {
              "type": "object",
              "properties": {
                "roleId": {
                  "type": "string"
                },
                "permissions": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            },
            "infraManagerProject": {
              "type": "string"
            },
            "infraManagerLocation": {
              "type": "string"
            },
            "infraManagerServiceAccount": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "description": "Response extends request schema with server-owned read-only fields.",
          "properties": {
            "status": {
              "type": "string",
              "description": "Server-managed GCP config status."
            },
            "deploymentCommand": {
              "type": "string",
              "description": "Generated deployment command."
            }
          }
        }
      ]
    },
    "awsConfig": {
      "allOf": [
        {
          "type": "object",
          "description": "AWS connection configuration. Server-owned fields (context[].status, context[].nextStackOperation, stackSet) are excluded.",
          "properties": {
            "context": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "accountId": {
                    "type": "string"
                  },
                  "regions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "roleName": {
              "type": "string"
            },
            "permissions": {
              "type": "object"
            },
            "managementAccount": {
              "type": "string"
            },
            "organizationRootId": {
              "type": "string"
            },
            "scopeTargetedOrganizationalUnitIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "scopeExplicitAccountIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "scopeExcludedAccountIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "scopeManagementAccountExplicitInScope": {
              "type": "boolean"
            }
          }
        },
        {
          "type": "object",
          "description": "Response extends request schema with server-owned read-only fields.",
          "properties": {
            "context": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "accountId": {
                    "type": "string"
                  },
                  "regions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "status": {
                    "type": "string",
                    "description": "Server-managed per-account deployment status."
                  }
                }
              }
            }
          }
        }
      ]
    },
    "collaborators": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "editor",
              "user"
            ]
          }
        }
      }
    },
    "enabled": {
      "type": "boolean",
      "description": "false when the connection is disabled."
    },
    "status": {
      "type": "string",
      "description": "Overall connection status."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: updatecloudflowconnection