Skip to main content
Version: 12 - TBD

SyncConfig

class flow_api.sync_config.SyncConfig(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, cacert=<class 'flow_api.system.NotSet'>, children=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, is_bundle_content=<class 'flow_api.system.NotSet'>, is_enabled=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, own_private_key=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, record_metadata=<class 'flow_api.system.NotSet'>, remote_public_key=<class 'flow_api.system.NotSet'>, remote_url=<class 'flow_api.system.NotSet'>, roles=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, verify_ssl=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Resource

The configuration for synchronizing workspaces in Cloudomation Engine.

See the corresponding Resources class at SyncConfig

Parameters​

NameTypeDescription
allow_deletedbool
allow_normalbool
bundle_idUnionReference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DASHBOARD, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MCP_USER_TOOL, MESSAGE, OBJECT_TEMPLATE, PLUGIN, PYTHON_MODULE, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id
bundle_nameUnionThe name of the bundle. Will look up the bundle and set bundle_id.
bystr
cacertUnionThe CA certificate of the remote workspace. Only needed when using self-signed HTTPS certificates.
childrenUnionSubrecords to create in the SAME transaction as the record, as a mapping of {subrecord_type: [ {column: value, ...}, ... ]}. A generic, schema-derived create-with-children: a key is accepted iff it names a subrecord type whose parent is one of this record's ancestor tables — e.g. an object_template with object_template_attribute rows, a role with role_permission rows, or a flow with resource_wrapper rows. The parent foreign key (<parent>_id) is auto-wired to the new record; each child is validated by its own subrecord create-path. Passing children inline makes the record and its subrecords atomic (any child failure rolls the whole create/update back), replacing a create-then-add-N sequence with one round-trip. Exposed identically on REST create/update bodies and the GraphQL create_<type>/update_<type> mutation input (as an arbitrary-JSON scalar), and via MCP create_record/update_record, since it is a single schema-derived column with no per-surface code. Accepted on both create and update. Nesting to arbitrary depth IS supported: a child entry may itself carry a children key, validated recursively against THAT child subrecord type's own ancestor tables and created depth-first in the same transaction. (Under the current subrecord model the only externally-creatable chains happen to be one level deep — subrecords are not record-backed, so e.g. a record_metadata cannot be nested under an object_template_attribute — but the recursion is applied generically so any deeper externally-creatable chain works with no per-type code.) On read the children are exposed via their subrecord lists, not this field.
clsOptional
commitbool
commit_messageUnionThe commit message for this change.
debugboolif set, the content of the data being written will be logged.
descriptionUnionA multiline description of what this record is and does.
initOptional
is_bundle_contentUnionA flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content.
is_enabledUnionA flag to control if the sync_config can be used.
is_readonlyUnionA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DASHBOARD, DEVOLUTIONS_CONFIG, FILE, FLOW, MCP_USER_TOOL, OBJECT_TEMPLATE, PLUGIN, PROJECT, PYTHON_MODULE, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE
location_inheritanceUnionControls the project/bundle association of a newly created record when no project_id/project_name/bundle_id/bundle_name is specified in the create request. Depending on the record type different options are available: <table> <thead> <tr> <th>location_inheritance</th> <th>record types</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><code>created_by</code></td> <td>all</td> <td>use the same location as the identity which creates the record</td> </tr> <tr> <td><code>default</code></td> <td>all</td> <td>use the "Default project" where applicable or "Workspace" for record types which cannot be in a project</td> </tr> <tr> <td><code>wrapped_resource</code></td> <td>execution</td> <td>use the same location as the innermost resource which is wrapped</td> </tr> <tr> <td><code>resource</code></td> <td>execution</td> <td>use the same location as the resource on which the execution is based on</td> </tr> </tbody> </table> Notes: <ul> <li>If a <code>project_id</code>/<code>project_name</code>/<code>bundle_id</code>/<code>bundle_name</code> is specified in the request, it always takes precedence.</li> <li>The options <code>wrapped_resource</code> and <code>resource</code> only work with executions which are based on a resource, not with ad-hoc connections or executions of type "SCRIPT". If used with ad-hoc connections or "SCRIPT" it will fall back to <code>default</code>.</li> <li>If the record being created cannot be associated with the specified location, the fallback to <code>default</code> will be used.</li> <li>If <code>location_inheritance</code> is unset, the default value used depends on the type of identity which creates the record as well as the type of record which is created. If an execution is created by any identity which is not an execution, it defaults to <code>wrapped_resource</code>. In all other cases it defaults to <code>created_by</code>.</li> </ul>
nameUnionThe name of this record. Must be unique across a workspace.
own_private_keyUnionA RSA private key used to sign outgoing messages.
project_idUnionReference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DASHBOARD, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MCP_USER_TOOL, MESSAGE, OBJECT_TEMPLATE, PLUGIN, PYTHON_MODULE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.
project_nameUnionThe name of the project. Will look up the project and set project_id.
record_metadataUnionRecord metadata to attach in the SAME transaction as the record create/update, as a mapping of {key: data} (key: string up to 128 chars, data: arbitrary JSON). Each entry is written as a record_metadata subrecord, upserted by (record_id, key). This removes the create-then-add race: without it a flow/API must first create the record and then add its metadata in a second call, leaving a window where the record exists un-marked (and may already be committed to git before the marker lands). Passing record_metadata inline makes the record and its metadata atomic. Accepted (and applied) on both create and update. On read the metadata is exposed via the record_metadata subrecord list, not this field.
remote_public_keyUnionA RSA public key used to verify incoming messages.
remote_urlUnionThe URL of the remote workspace to connect to. If unset the workspace will listen for incoming connections.
rolesUnionThe roles this identity has.
selectOptional
track_in_gitUnionShould new records automatically be tracked in git.
verify_sslUnionA flag to control if SSL certificates should be verified.

Constants​

RESOURCE = sync_config

Methods​

add_identity_role​

add_object_template_attribute_default_reference_id​

add_record_comment​

add_record_comment_assignee_identity_id​

add_record_metadata​

add_record_tag​

add_record_user​

add_resource_wrapper​

bundle​

clone​

commit​

created_by_identity​

delete​

deleted_by_identity​

duplicate​

execution_list_sync_config_id​

exists​

export​

get​

get_dict​

git_log_list​

git_restore​

identity_role_list​

metadata​

metadata_exists​

modified_by_identity​

object_template_attribute_list_default_reference_id​

organization​

pending_delete_identity_id_identity​

pending_restore_identity_id_identity​

pending_trash_identity_id_identity​

process​

project​

record_comment_list​

record_comment_list_assignee_identity_id​

record_comment_list_author_identity_id​

record_comment_list_resolved_by​

record_comment_read_list​

record_list_created_by​

record_list_deleted_by​

record_list_modified_by​

record_list_pending_delete_identity_id​

record_list_pending_restore_identity_id​

record_list_pending_trash_identity_id​

record_log_list​

record_metadata_list​

record_tag_list​

record_user_list​

resource_wrapper_list​

restore​

save​

workspace​