Excluir uma automação usando OpenAPI

Exclua uma automação do Automation Hub usando o ponto de extremidade OpenAPI DELETE.

Excluir uma automação do Automation Hub chamando o endpoint DELETE /api/v1/openapi/automations/{id} .

Pré-requisitos

• Você tem um token de API do Automation Hub ativo. Para obter instruções, consulte Gerar seu token a partir do Automation Hub.
• Você sabe o ID numérico da automação que deseja excluir. Você pode recuperá-lo do URL da automação no Automation Hub ou por meio de GET /api/v1/openapi/automations chamada.
• Você tem a função de Administrador do sistema ou Gerente de programa .

Excluir uma automação

1. Construa o URL de solicitação usando o ID da automação:

   DELETE https://{baseUrl}/api/v1/openapi/automations/{id}
   

2. Inclua o cabeçalho de autenticação necessário:

   Cabeçalho	Valor
   x-ah-openapi-app-key	Seu token de API do Automation Hub
   x-ah-openapi-auth	openapi
   Content-Type	application/json

3. Opcionalmente, inclua um comentário no corpo da solicitação:

   {
     "comment": "Removing duplicate entry."
   }
   

4. Envie a solicitação.

Resultados

Uma exclusão bem-sucedida retorna HTTP 200. A automação será removida permanentemente do tenant e não aparecerá mais no Automation Hub.

Códigos de erro

Código	Significado
400	Solicitação inválida — o corpo da solicitação está malformado ou um campo obrigatório é inválido.
404	Não encontrado — não existe automação com o ID especificado no tenant.

Exemplo: excluir várias automações usando um script

Use o seguinte script do PowerShell para excluir uma lista de automações por ID:

$baseUrl  = "https://<your-tenant>.automation-hub.uipath.com"
$appKey   = "<your-api-token>"
$ids      = @(1001, 1002, 1003)
$comment  = "Bulk cleanup"

foreach ($id in $ids) {
    $response = Invoke-RestMethod `
        -Method Delete `
        -Uri "$baseUrl/api/v1/openapi/automations/$id" `
        -Headers @{
            "x-ah-openapi-app-key" = $appKey
            "x-ah-openapi-auth"    = "openapi"
            "Content-Type"         = "application/json"
        } `
        -Body (ConvertTo-Json @{ comment = $comment })
    Write-Host "Deleted $id — Status: $($response.StatusCode)"
}

Para obter mais informações, consulte a página Referências da API .