- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma

Guia de API da UiPath Automation Cloud
Baixar eventos
Baixe eventos de auditoria como um arquivo CSV. Cada experiência de registro fornece pontos de extremidade de download separados.
Experiência de registro em log unificada
A experiência de log unificada usa esses pontos de extremidade de API e fornece dois escopos:
- Nível de organização:
/orgaudit_/ - Nível do tenant:
/tenantaudit_/
Essas APIs baixam informações de auditoria em todos os serviços da UiPath integrados à estrutura unificada.
Ponto de Extremidade da API
Nível da organização
GET {accessURL}/{org-name}/orgaudit_/api/query/downloadevents
Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:
| Cloud Platform | URL de acesso |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Automation Cloud Setor público | https://govcloud.uipath.us/ |
| Automation Cloud dedicado | https://{customURL}.dedicated.uipath.com/ |
Nível do tenant
GET {accessURL}/{org-name}/{tenant-name}/tenantaudit_/api/query/downloadevents
Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:
| Cloud Platform | URL de acesso |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Automation Cloud Setor público | https://govcloud.uipath.us/ |
| Automation Cloud dedicado | https://{customURL}.dedicated.uipath.com/ |
Escopos
Requer um dos seguintes escopos:
- PM.Audit
- PM.Audit.Read
Cabeçalhos de solicitação.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.
Parâmetros de Consulta
| Parâmetro | Tipo | Description |
|---|---|---|
from (opcional) | DateTime | Início do intervalo de tempo |
to (opcional) | DateTime | Fim do intervalo de tempo |
source (opcional) | Matriz [String] | Lista de origens de eventos |
target (opcional) | Matriz [String] | Lista de categorias |
type (opcional) | Matriz [String] | Lista de atividades |
userIds (opcional) | Matriz [String] | Lista de identificadores de usuários |
status (opcional) | Número inteiro |
|
Resposta
200 OK
Baixa um arquivo.CSV contendo os eventos de auditoria selecionados.
Exemplo de solicitação
Nível da organização
curl --location 'https://cloud.uipath.com/{org-name}/orgaudit_/api/query/downloadevents?from=2024-12-24T00:00:00Z&to=2025-03-24T00:00:00Z&status=0' \
--header 'Authorization: Bearer {token}'
curl --location 'https://cloud.uipath.com/{org-name}/orgaudit_/api/query/downloadevents?from=2024-12-24T00:00:00Z&to=2025-03-24T00:00:00Z&status=0' \
--header 'Authorization: Bearer {token}'
Nível do tenant
curl --location 'https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z&source
=1bf33a0d-fbe0-4fe5-b7f6-c61379878989&source
=afef9b33-872c-4c10-9039-009866131e77&source=f51fa47f-a015-4b0b-b9c3-28caa3d00788
&source=3e5e8c49-5e7f-41cc-a2ec-c42f9deebb70&target=5c8402f9-0529-4317-8790-568842208620&target=19d7f55c-c580-4bec-b6f0-d5deab0b17f3&target=09d74792-21f4-4bc9-a650-9020f8811c32&type=a912d4d8-df39-44c7-b696-27c5660c06da&type
=a57e644c-2d80-4f40-ac3b-b7c934d0a510&userIds
=4120ea1c-5d2b-4287-ba6c-904c694d2767&userIds=a922809d-3956-4376-8406-4eb2d6d6b363' \
--header 'Authorization: Bearer {token}'
curl --location 'https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z&source
=1bf33a0d-fbe0-4fe5-b7f6-c61379878989&source
=afef9b33-872c-4c10-9039-009866131e77&source=f51fa47f-a015-4b0b-b9c3-28caa3d00788
&source=3e5e8c49-5e7f-41cc-a2ec-c42f9deebb70&target=5c8402f9-0529-4317-8790-568842208620&target=19d7f55c-c580-4bec-b6f0-d5deab0b17f3&target=09d74792-21f4-4bc9-a650-9020f8811c32&type=a912d4d8-df39-44c7-b696-27c5660c06da&type
=a57e644c-2d80-4f40-ac3b-b7c934d0a510&userIds
=4120ea1c-5d2b-4287-ba6c-904c694d2767&userIds=a922809d-3956-4376-8406-4eb2d6d6b363' \
--header 'Authorization: Bearer {token}'
Experiência de registro em log clássica
Ponto de Extremidade da API
GET {accessURL}/audit_/api/auditlogs/download
Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:
| Cloud Platform | URL de acesso |
|---|---|
| Automation Cloud | https://cloud.uipath.com/ |
| Automation Cloud Setor público | https://govcloud.uipath.us/ |
| Automation Cloud dedicado | https://{customURL}.dedicated.uipath.com/ |
Escopos
Requer um dos seguintes escopos:
- PM.Audit
- PM.Audit.Read
Cabeçalhos de solicitação.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.
Parâmetros de Consulta
| Parâmetro de consulta | Tipo de dados | Description |
|---|---|---|
language (opcional) | String | Especifica o idioma de exibição disponível, na forma reduzida. Por exemplo, en, fr, de, ja etc. |
size (opcional) | Int32 | Especifica o tamanho do download. |
Resposta
200 OK
A lista de eventos de auditoria é baixada para sua máquina, no formato .csv.
Exemplo de solicitação
Digamos que você reuniu todas as informações necessárias para criar a chamada de API.
- Seu
{baseURL}é:https://cloud.uipath.com/{organizationName} - Seu
{access_token}é:1234(para considerações de comprimento). - Você define os seguintes parâmetros de consulta:
language=ensize= 13, para baixar as 13 principais entradas.
A chamada deve ser semelhante ao seguinte exemplo (CURL):
curl --location --request GET ' https://cloud.uipath.com/{organizationName}/audit_/api/auditlogs/download?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET ' https://cloud.uipath.com/{organizationName}/audit_/api/auditlogs/download?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
- Experiência de registro em log unificada
- Ponto de Extremidade da API
- Escopos
- Cabeçalhos de solicitação.
- Parâmetros de Consulta
- Resposta
- Exemplo de solicitação
- Experiência de registro em log clássica
- Ponto de Extremidade da API
- Escopos
- Cabeçalhos de solicitação.
- Parâmetros de Consulta
- Resposta
- Exemplo de solicitação