Connector

class resources.connector.Connector

Base class: Resource

Connection information for a system which can be accessed for automation by Cloudomation Engine.

See the corresponding Flow Api class at Connector

Property	Description	Type	Import/Export
bundle_id	Reference 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	UUID(as_uuid=False)	both
bundle_name	The name of the bundle. Will look up the bundle and set bundle_id.	String(length=128)	import only
children	Subrecords 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.	JSONEncodedData()	neither
commit_message	The commit message for this change.	Text()	import only
connector_type	The type of the connector / the type of the remote system.	Enum('AWS', 'AZURE', 'AZUREAI', 'FTP', 'GIT', 'GOOGLE', 'HTTP', 'IMAP', 'K8S', 'LDAP', 'MYSQL', 'OPENAI', 'OVH', 'PS', 'REDIS', 'REST', 'SCP', 'SFTP', 'SMB', 'SMTP', 'SOAP', 'SQLMSSQL', 'SQLORACLE', 'SQLPG', 'SSH', 'VAULT', 'WEBDAV', 'XMLRPC', name='connectortype')	both
created_at		DateTime(timezone=True)	export only
created_by		UUID(as_uuid=False)	export only
deleted_at	When the record was moved to the trashbin. Null while the record is active.	DateTime(timezone=True)	import only
deleted_by		UUID(as_uuid=False)	import only
description	A multiline description of what this record is and does.	Text()	both
has_deprecation		Boolean()	export only
has_syntax_error		Boolean()	export only
id		UUID(as_uuid=False)	neither
input_schema		JSONEncodedData()	neither
is_bundle_content	A 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.	Boolean()	both
is_bundle_readonly		Boolean()	neither
is_deleted	Whether the record has been permanently deleted. Records in the trashbin are indicated by deleted_at instead.	Boolean()	export only
is_project_readonly		Boolean()	neither
is_readonly	A 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	Boolean()	both
location_inheritance	Controls 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: location_inheritance record types description created_by all use the same location as the identity which creates the record default all use the "Default project" where applicable or "Workspace" for record types which cannot be in a project wrapped_resource execution use the same location as the innermost resource which is wrapped resource execution use the same location as the resource on which the execution is based on Notes: If a project_id/project_name/bundle_id/bundle_name is specified in the request, it always takes precedence. The options wrapped_resource and resource 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 default. If the record being created cannot be associated with the specified location, the fallback to default will be used. If location_inheritance 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 wrapped_resource. In all other cases it defaults to created_by.	String(length=128)	import only
max_runtime_minutes	The maximum runtime of executions of this connector in minutes. If set to 0, there is no limit. If set to null, the EXECUTION_MAX_RUNTIME_MINUTES workspace configuration will be used when creating an execution of this connector.	Integer()	export only
modified_at		DateTime(timezone=True)	neither
modified_by		UUID(as_uuid=False)	neither
name	The name of this record. Must be unique across a workspace.	String(length=128)	both
organization_id		UUID(as_uuid=False)	export only
output_schema		JSONEncodedData()	neither
pending_delete_commit		Boolean()	neither
pending_delete_identity_id		UUID(as_uuid=False)	neither
pending_operation_id		UUID(as_uuid=False)	neither
pending_restore_commit		Boolean()	neither
pending_restore_identity_id		UUID(as_uuid=False)	neither
pending_trash_commit		Boolean()	neither
pending_trash_identity_id		UUID(as_uuid=False)	neither
priority	The execution priority of the connector. Will be inherited to executions of this connector. If unset the EXECUTION_DEFAULT_PRIORITY workspace configuration will be used. Higher priority executions will be processed first.	SmallInteger()	both
project_id	Reference 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.	UUID(as_uuid=False)	both
project_name	The name of the project. Will look up the project and set project_id.	String(length=128)	import only
record_metadata	Record 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.	JSONEncodedData()	neither
record_type		Enum('EXECUTION', 'MESSAGE', 'PROCESS', 'BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DASHBOARD', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MCP_USER_TOOL', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'PYTHON_MODULE', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')	neither
record_version	Optimistic-concurrency version token. Read-only, computed on read from modified_at at full (microsecond) precision (request it by name; not in the default summary). Pass the value you last read back as expected_version on update to guard against lost updates: if the record changed meanwhile the write is rejected with HTTP 409 (StaleWrite) carrying the current record and token. Not stored; not exported.	Text()	neither
recurse_pending_delete		Boolean()	neither
recurse_pending_restore		Boolean()	neither
recurse_pending_trash		Boolean()	neither
repository_path	The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH	String(length=256)	neither
resolved_icon	The record's resolved display icon: the concrete subtype's own icon column (dashboard/project/bundle/object_template/workspace/user/plugin_action), or NULL when the subtype carries no icon. Read-only, computed on read (request it by name; not in the default summary); not stored, not exported. Lets the polymorphic base record expose a per-record icon (sidebar quick-access, quick-search, generic record lists) without shadowing the subtype icon columns. Named resolved_icon, not icon, for the same reason record_version is not version: a base virtual column named icon would override the subtype icon columns in their own all_columns (ancestors overwrite descendants), turning them read-only and non-exporting.	Text()	neither
resource_type		Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DASHBOARD', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MCP_USER_TOOL', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'PYTHON_MODULE', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype')	neither
schema_version		String(length=128)	both
track_in_git	Should new records automatically be tracked in git.	Boolean()	both
validation_error	The validation result of the input value against the input schema, excluding required fields.	Boolean()	export only
value	The static configuration of the connector. Must be valid against the input schema of the connector type, except for required fields which can be omitted here, and can be set when using the connector.	JSONEncodedData()	both
value_char_count	Computed on read: the chars of value. A cheap size gate so callers can decide whether to fetch the full content body. Read-only; not stored; not exported.	BigInteger()	neither
value_size_bytes	Computed on read: the bytes of value. A cheap size gate so callers can decide whether to fetch the full content body. Read-only; not stored; not exported.	BigInteger()	neither
workspace_id		UUID(as_uuid=False)	export only