按 ID 获取连接

API 参考，用于按 ID 检索单个 Integration Service 连接，并提供端点 URL、路径参数和示例响应。

按 ID 检索单个连接。

API 端点

GET BaseURL/v1/Connections/{connectionId}

• 使用您所在云平台的连接 API基本 URL 。

请求标头

页眉	值
授权	承载 <your-access-token>
X-UIPATH-帐户 ID	<tenant>
X-UIPATH-文件夹密钥	保存连接的文件夹键

将尖括号 <...> 之间的所有值替换为其相应的用例值。

该令牌是您在授权外部应用程序时收到的令牌。有效期为 1 小时，然后您需要生成新令牌，或请求刷新令牌。有关如何注册外部应用程序并获取此令牌的信息，请参阅API 访问权限。

重要提示：

外部应用程序必须以由X-UIPATH-FolderKey标头标识的单个文件夹为目标。省略标头的请求将返回 400 Bad Request。

路径变量

路径变量	数据类型	描述	默认值
连接 ID (必填项)	string	要检索的连接 ID。	不适用

查询参数

查询参数	数据类型	描述	默认值
包括配置	boolean	返回连接的配置。仅适用于拥有配置读取作用域的调用者。系统永远不会返回密码值，例如 API 密钥和 OAuth 令牌。	false

响应

200 OK

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "My Salesforce connection",
  "Connector": {
    "Key": "uipath-salesforce-sfdc",
    "Name": "Salesforce"
  },
  "Folder": {
    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "State": "Connected",
  "IsDefault": true,
  "CreateTime": "2026-09-10T10:20:24.485Z",
  "UpdateTime": "2026-09-10T10:20:24.485Z"
}

400 Bad Request

请求未提供X-UIPATH-FolderKey标头。

401 未经授权

访问令牌缺失、过期或无效。

403 Forbidden

外部应用程序不具备所需的作用域，或者在请求的文件夹中没有Connections.View权限。

404 未找到

连接不存在，或其所在文件夹不是请求的目标文件夹。请求的文件夹外部的连接将返回 404，而不是 403。