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.

Punto final de API

GET BaseURL/elements/{elementKey}/export

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

Solicitar encabezados.

Encabezado	Valor
Autorización	Portador <your-access-token>
X-UIPATH-AccountId	<tenant>

Reemplaza todos los valores entre corchetes angulares <...> con sus valores de caso de uso correspondientes.

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.

Importante:

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 ruta

Variable de ruta	Tipo de datos	Descripción	Valor predeterminado
elementKey (required)	string	The key of the custom connector you want to download.	N/A

Parámetros de consulta

Parámetro de consulta	Tipo de datos	Descripción	Valor predeterminado
2020.x	string	The connector version to download. When omitted, the current published version is used.	N/A

Respuesta

200 OK

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

400 Bad Request

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

401 No autorizado

The access token is missing, expired, or invalid.

403 Forbidden

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

404 No encontrado

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