- Démarrage
- API de connexions
- Obtenir des connexions
- Obtenir la connexion par ID
- API des connecteurs
Obtenir la connexion par ID
Référence d'API pour récupérer une seule connexion Integration Service par ID, avec l'URL du point de terminaison, les paramètres de chemin et l'exemple de réponse.
Récupère une seule connexion par ID.
Point de terminaison de l’API
GET BaseURL/v1/Connections/{connectionId}
- Utilisez l' URL de base de l'API de connexion pour la plate-forme cloud sur laquelle vous vous trouvez.
En-têtes de requête.
| En-tête | Valeur (Value) |
|---|---|
| Autorisation | Porteur <your-access-token> |
| X-UIPATH-IDCompte | <tenant> |
| X-UIPATH-CléDossier | La clé du dossier contenant les connexions |
Remplacez toutes les valeurs entre les chevrons <...> par leurs valeurs de cas d’utilisation correspondantes.
Le jeton est celui que vous avez reçu lorsque vous avez autorisé l’application externe. Elle est disponible pendant 1 heure, puis vous devez en générer une nouvelle ou demander un jeton d’actualisation. Consultez Accès à l'API pour savoir comment enregistrer une application externe et obtenir ce jeton.
Les applications externes doivent cibler un seul dossier, identifié par l’en-tête X-UIPATH-FolderKey . Une requête qui omet l'en-tête renvoie 400 Bad Request.
Variables de chemin d'accès
| Variable de chemin d’accès | Type de données | Description | Valeur par défaut |
|---|---|---|---|
| ID de connexion (requis) | string | L'ID de la connexion que vous souhaitez récupérer. | NA |
Paramètres de requête
| Paramètre de requête | Type de données | Description | Valeur par défaut |
|---|---|---|---|
| InclureConfigurations | boolean | Renvoie la configuration de la connexion. Disponible uniquement pour les appelants qui détiennent l’étendue de lecture de la configuration. Les valeurs secrètes, telles que les clés API et les jetons OAuth, ne sont jamais retournées. | false |
Réponses
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"
}
Les noms des champs sont en camelCase. Les valeurs enum conservent leur casse, par exemple state est Enabled ou Failed. Les champs sans valeur sont laissés en dehors de la réponse au lieu d'être renvoyés sous la forme null.
La réponse inclut le champ connectionType lorsque la requête définit inclureConfigurations sur true. Sans inclureConfigurations, le champ peut être absent de la réponse. La valeur est l’une des suivantes:
Public: une connexion standard , qui utilise les API du connecteur public par défaut.Private: une connexion privée, qui achemine le trafic via le relais UiPath ou un lien privé. Pour plus de détails, consultez la section Connexion à des systèmes locaux.
connectionType décrit la connexion. Ce n'est pas la même chose que pour connector.isPrivate, qui indique si le connecteur est un connecteur privé (personnalisé).
400 Requête incorrecte
La requête ne fournissait pas l’en-tête X-UIPATH-FolderKey .
401 Non autorisé
Le jeton d’accès est manquant, a expiré ou n’est pas valide.
403 Forbidden
L’application externe ne possède pas l’étendue requise ou ne dispose pas de l’autorisation Connections.View dans le dossier demandé.
Erreur 404 - Page introuvable
La connexion n’existe pas ou se trouve dans un dossier autre que celui ciblé par la requête. Une connexion en dehors du dossier demandé renvoie 404, et non 403.