Obter conexão por ID

Referência de API para recuperar uma única conexão do Integration Service por ID, com a URL do ponto de extremidade, parâmetros de caminho e resposta de exemplo.

Recupera uma única conexão por ID.

Ponto de Extremidade da API

GET BaseURL/v1/Connections/{connectionId}

• Use o URL base da API do Connections para a plataforma de nuvem em que você está.

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <your-access-token>
IdDaConta-X-UIPATH	<tenant>
ChaveDaPastaX-UIPATH	A chave da pasta que contém as conexões

Substitua todos os valores entre os colchetes angulares <...> por seus valores de caso de uso correspondentes.

O token é aquele que você recebeu quando autorizou o aplicativo externo. Ele estará disponível por 1 hora. Depois, você precisa gerar um novo ou solicitar um token de atualização. Consulte Acesso à API para saber como registrar um aplicativo externo e obter esse token.

Importante:

Os aplicativos externos devem ter como destino uma única pasta, identificada pelo cabeçalho X-UIPATH-FolderKey . Uma solicitação que omite o cabeçalho retorna 400 Bad Request.

Variáveis de caminho

Variável Path	Tipo de dados	Description	Valor padrão
ConnectionId (obrigatório)	string	O ID da conexão que você deseja recuperar.	NA

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description	Valor padrão
IncluirConfigurações	boolean	Retorna a configuração da conexão. Disponível apenas para chamadores que detêm o escopo de leitura de configuração. Valores secretos, como chaves de API e tokens do OAuth, nunca são retornados.	false

Resposta

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

A solicitação não forneceu o cabeçalho X-UIPATH-FolderKey .

401 não autorizado

O token de acesso está ausente, expirou ou é inválido.

403 Forbidden

O aplicativo externo não contém o escopo necessário ou não tem a permissão Connections.View na pasta solicitada.

404 Não encontrado

A conexão não existe ou está em uma pasta diferente daquela a que a solicitação foi direcionada. Uma conexão fora da pasta solicitada retorna 404, não 403.