Download custom connector

API reference for downloading a custom Integration Service connector as a .connector file, with the endpoint URL, path parameter, and query parameters.

Downloads a custom connector as a .connector file.

Point de terminaison de l’API

GET BaseURL/elements/{elementKey}/export

• Use the Connectors API Base URL for the cloud platform you are on.

En-têtes de requête.

En-tête	Valeur (Value)
Autorisation	Porteur <your-access-token>
X-UIPATH-AccountId	<tenant>

Remplacez toutes les valeurs entre les chevrons <...> par leurs valeurs de cas d’utilisation correspondantes.

The token is the one you received when you authorized the external application. It is available for 1 hour, then you need to generate a new one, or request a refresh token. See API access for how to register an external application and obtain this token.

Important :

Only custom connectors can be downloaded. Requesting a catalog (prebuilt UiPath) connector returns 400 Bad Request. This endpoint is not folder-scoped — no folder key is required.

Variables de chemin d'accès

Variable de chemin d’accès	Type de données	Description	Valeur par défaut
elementKey (required)	string	The key of the custom connector you want to download.	NA

Paramètres de requête

Paramètre de requête	Type de données	Description	Valeur par défaut
version	string	The connector version to download. When omitted, the current published version is used.	NA

Réponses

200 OK

Returns the connector as a binary .connector file (application/octet-stream), named {elementKey}_{version}.connector.

400 Requête incorrecte

The requested connector is a catalog (prebuilt UiPath) connector, which cannot be exported.

401 Non autorisé

The access token is missing, expired, or invalid.

403 Forbidden

The external application does not hold the IS.Connectors.Read scope.

Erreur 404 - Page introuvable

No connector exists for the given key, or the requested version was not found.