1. Docs
  2. API Reference
  3. Delete an audit-log export job

Delete an audit-log export job

DELETE/portal/v1/accounts/{accountSlug}/audit-log/admin/export/{id}

Deletes the rendered file from object storage (if any) and the job record. Idempotent against an already-swept object.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability audit.viewSecurity

View the account-wide audit log. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

idstring Required

Responses

Deletes the rendered file from object storage (if any) and the job record. Idempotent against an already-swept object.

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/value/audit-log/admin/export/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Deletes the rendered file from object storage (if any) and the job record. Idempotent against an already-swept object.

(empty body)
 Related endpoints
GETLive-tail admin audit-log events (SSE)
GETQuery admin audit-log events
GETList recent audit-log export jobs
POSTCreate an admin audit-log export job (CSV / NDJSON)
GETGet an audit-log export job
GETGet an admin audit-log row with related events
 Was this page helpful?

Tell us how we can improve this guide.

Canopy