Tools Connections

Connections tools

This page is generated from the code by scripts/gen_wiki_tools.py — do not edit by hand.

5 tools · category token connections · enable with DATAVERSE_TOOLS=connections (unset enables every category)

Tool-Index · Home

Write tools additionally require DATAVERSE_ALLOW_WRITE=true; delete tools require DATAVERSE_ALLOW_DELETE=true.

---

dataverse_create_connection_reference

Write · non-idempotent · category connections

Create a new connection reference in the Dataverse environment.

A connection reference links a logical connector type (connectorid) to an actual connection (connectionid). Cloud flows and apps reference the logical name rather than a specific connection, enabling portable solutions.

Provide connection_id to assign a connection immediately, or omit and use dataverse_update_connection_reference later to wire up the connection.

Requires DATAVERSE_ALLOW_WRITE=true.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
display_name	str	yes	—	Display name for the connection reference. (min_len=1)
logical_name	str	yes	—	Unique logical name for the connection reference (e.g., 'new_myconnectionreference'). Must be unique within the environment. (min_len=1)
connector_id	str	yes	—	ID of the public/shared connector this reference targets (e.g., '/providers/Microsoft.PowerApps/apis/shared_sharepointonline'). (min_len=1)
connection_id	str | None	no	None	ID of the connection in API hub to assign immediately. Omit to leave unassigned and wire up later via dataverse_update_connection_reference.
description	str | None	no	None	Description of the connection reference.
solution_unique_name	str | None	no	None	Unique name of the solution to associate this connection reference with. Passed as the MSCRM.SolutionUniqueName request header. (pattern=^[a-zA-Z_][a-zA-Z0-9_]*$)

Returns {"created": ..., "logical_name": ..., "display_name": ..., "connector_id": ..., "solution_unique_name": ..., "location": ...}. Errors return {"error": true, "message": "..."}.

---

dataverse_delete_connection_reference

Delete · non-idempotent · category connections

Delete a connection reference from the Dataverse environment.

WARNING: Deleting a connection reference will break any cloud flows or apps that reference it. Verify nothing depends on this reference before deleting.

Only unmanaged connection references can be deleted. Managed references (ismanaged=true) must be removed by uninstalling the solution that owns them.

Requires DATAVERSE_ALLOW_DELETE=true.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
connection_reference_id	str	yes	—	GUID of the connection reference to delete. (min_len=36, max_len=36)

Returns {"deleted": ..., "connection_reference_id": ...}. Errors return {"error": true, "message": "..."}.

---

dataverse_get_connection_reference

Read · idempotent · category connections

Get a single connection reference by GUID or logical name.

Returns the full record including the assigned connection ID, connector ID, status, and managed state. An empty connectionid means no connection has been wired up yet — use dataverse_update_connection_reference to assign one.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
connection_reference_id	str | None	no	None	GUID of the connection reference. (min_len=36, max_len=36)
connection_reference_logical_name	str | None	no	None	Logical name (connectionreferencelogicalname) of the connection reference (e.g., 'new_myconnectionreference'). (min_len=1)

Returns {"record": ...}. Errors return {"error": true, "message": "..."}.

---

dataverse_list_connection_references

Read · idempotent · category connections

List connection references in the Dataverse environment.

Returns connectionreferenceid, logical name, display name, connector ID, connection ID (empty string if not yet assigned), status, and managed state.

Filter by connector_id to find all references for a specific connector type. Filter by statecode=0 to show only active references. Use the connection_id field to identify which references still need a connection assigned — an empty connectionid means the flow or app using it will fail at runtime.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
connector_id	str | None	no	None	Filter by connector ID (e.g., '/providers/Microsoft.PowerApps/apis/shared_sharepointonline'). Exact match on the connectorid field. (min_len=1)
statecode	int | None	no	None	Filter by status: 0 = Active, 1 = Inactive. Omit to return all. (ge=0, le=1)
filter	str | None	no	None	Additional OData $filter expression (e.g., "ismanaged eq false"). Combined with other filter parameters using 'and'.
top	int	no	50	Maximum number of records to return. (ge=1, le=5000)

Returns {"records": ..., "count": ..., "has_more": ...}. Errors return {"error": true, "message": "..."}.

---

dataverse_update_connection_reference

Write · idempotent · category connections

Update a connection reference — most commonly used to assign a connection.

Setting connection_id wires up an actual connection to the reference, enabling cloud flows and apps that use this reference to run successfully. Pass an empty string for connection_id to clear the assigned connection.

Provide solution_unique_name to associate this reference with a solution as part of the update (passed as MSCRM.SolutionUniqueName request header).

Use dataverse_list_connection_references to find references with an empty connectionid (not yet wired up) after solution import.

Requires DATAVERSE_ALLOW_WRITE=true.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
connection_reference_id	str	yes	—	GUID of the connection reference to update. (min_len=36, max_len=36)
connection_id	str | None	no	None	Connection ID in API hub to assign. Pass an empty string to clear the current connection. Omit to leave unchanged.
display_name	str | None	no	None	New display name for the connection reference. (min_len=1)
description	str | None	no	None	New description for the connection reference.
solution_unique_name	str | None	no	None	Unique name of the solution to associate this connection reference with. Passed as the MSCRM.SolutionUniqueName request header on the PATCH. (pattern=^[a-zA-Z_][a-zA-Z0-9_]*$)

Returns {"updated": ..., "connection_reference_id": ..., "solution_unique_name": ..., "changes": ...}. Errors return {"error": true, "message": "..."}.

---