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

Guia de API da UiPath Automation Cloud
Download audit events as a CSV file. Each logging experience provides separate download endpoints.
The unified logging experience uses these API endpoints and provides two scopes:
-
Organization-level:
/orgaudit_/ -
Tenant-level:
/tenantaudit_/
These APIs download audit information across UiPath services onboarded to the unified framework.
Ponto de Extremidade da API
Nível da organização
GET
https://cloud.uipath.com/{org-name}/orgaudit_/api/query/downloadeventsNível do tenant
GET
https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/downloadeventsEscopos
Requires one of the following scopes:
- 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'{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 | Start of time interval |
to (opcional)
| DateTime | End of time interval |
source (opcional)
| Array [String] | List of event sources |
target (opcional)
| Array [String] | List of categories |
type (opcional)
| Array [String] | List of activities |
userIds (opcional)
| Array [String] | List of user identifiers |
status (opcional)
| Número inteiro |
|
Resposta
200 OK
Downloads a .CSV file containing the selected audit events.
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}'Ponto de Extremidade da API
GET
https://cloud.uipath.com/audit_/api/auditlogs/downloadEscopos
Requires one of the following scopes:
- 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'{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 |
|---|---|---|
|
(opcional) |
String |
Especifica o idioma de exibição disponível, na forma reduzida. Por exemplo,
en, fr, de, ja etc.
|
|
(opcional) |
Int32 |
Especifica o tamanho do download. |
Resposta
200 OK
.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=en -
size= 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