- Primeros pasos
- API de conexiones
- Obtener conexiones
- Obtener conexión por ID
- API de conectores
Obtener conexión por ID
Referencia de la API para recuperar una única conexión de Integration Service por ID, con la URL del punto final, los parámetros de ruta y la respuesta de ejemplo.
Recupera una sola conexión por ID.
Punto final de API
GET BaseURL/v1/Connections/{connectionId}
- Utiliza la URL base de la API de conexiones para la plataforma en la nube en la que te encuentras.
Solicitar encabezados.
| Encabezado | Valor |
|---|---|
| Autorización | Portador <your-access-token> |
| X-UIPATH-IdDeCuenta | <tenant> |
| X-UIPATH-ClaveDeCarpeta | La clave de la carpeta que contiene las conexiones |
Reemplaza todos los valores entre corchetes angulares <...> con sus valores de caso de uso correspondientes.
El token es el que recibiste al autorizar la aplicación externa. Está disponible durante 1 hora, luego debes generar uno nuevo o solicitar un token de actualización. Consulta Acceso a la API para saber cómo registrar una aplicación externa y obtener este token.
Las aplicaciones externas deben dirigirse a una sola carpeta, identificada por el encabezado X-UIPATH-FolderKey . Una solicitud que omite el encabezado devuelve 400 Bad Request.
Variables de ruta
| Variable de ruta | Tipo de datos | Descripción | Valor predeterminado |
|---|---|---|---|
| IDDeConexión (obligatorio) | string | El ID de la conexión que desea recuperar. | N/A |
Parámetros de consulta
| Parámetro de consulta | Tipo de datos | Descripción | Valor predeterminado |
|---|---|---|---|
| IncluirConfiguraciones | boolean | Devuelve la configuración de la conexión. Disponible solo para las personas que llaman que tienen el ámbito de lectura de configuración. Los valores secretos, como las claves API y los tokens OAuth, nunca se devuelven. | false |
Respuesta
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": "Enabled",
"isDefault": true,
"createTime": "2026-09-10T10:20:24.485Z",
"updateTime": "2026-09-10T10:20:24.485Z"
}
{
"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": "Enabled",
"isDefault": true,
"createTime": "2026-09-10T10:20:24.485Z",
"updateTime": "2026-09-10T10:20:24.485Z"
}
Los nombres de los campos están en CamelCase. Los valores Enum mantienen su mayúscula y minúscula, por ejemplo state es Enabled o Failed. Los campos sin valor se dejan fuera de la respuesta en lugar de devolverse como null.
La respuesta incluye el campo connectionType cuando la solicitud establece includeConfigs en true. Sin includeConfigs, el campo puede estar ausente de la respuesta. El valor es uno de los siguientes:
Public: una conexión estándar , que utiliza las API del conector público predeterminadas.Private: una conexión privada, que enruta el tráfico a través de UiPath Relay o Private Link. Para obtener más información, consulta Conectar a sistemas locales.
connectionType describe la conexión. No es lo mismo que connector.isPrivate, que muestra si el conector en sí es un conector privado (personalizado).
400 Bad Request
La solicitud no proporcionó el encabezado X-UIPATH-FolderKey .
401 No autorizado
Falta el token de acceso, ha caducado o no es válido.
403 Forbidden
La aplicación externa no tiene el ámbito necesario o no tiene permiso Connections.View en la carpeta solicitada.
404 No encontrado
La conexión no existe o está en una carpeta distinta a la que se dirigía la solicitud. Una conexión fuera de la carpeta solicitada devuelve 404, no 403.