audit-logs

Get event details

Returns details of a single audit log event by its cloud event ID.

get/1.3/audit-logs/{cloudEventID}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/audit-logs/{cloudEventID}
  • Auth: HTTP bearer

Path parameters

cloudEventIDstring required

Cloud event ID (ULID format)

Example:01HQXYZ123456789ABCDEFGHJK

Response

Successful response

timestring date-time required

Timestamp of the event

auth_typestring required

Authentication type used (e.g., 'gui', 'api', 'basic_auth')

cloud_event_idstring required

Cloud event ID in ULID format

upcloud_correlation_idstring required

UpCloud correlation ID for request tracing

resource_type'account' | 'auth' | 'init-script' | 'managed-database' | 'managed-loadbalancer' | 'managed-loadbalancer-certificate-bundle' | 'managed-object-storage' | 'network-gateway' | 'server' | 'storage' | 'uks' | 'ssh-key' required

Type of resource affected

resource_sub_typestring

Subtype of resource affected (e.g., 'session-api-token')

action'create' | 'read' | 'update' | 'delete' | 'access-granted' | 'access-granted-kubeconfig' | 'access-modified' | 'access-update' | 'maintenance-start' | 'writes-enable' | 'attach' | 'clone' | 'detach' | 'login' | 'logout' | 'start' | 'stop' | 'owner-change' required

Action performed

origin'api' | 'gui' | 'upcloud_internal' required

Origin of the request

account_usernamestring required

Username that performed the action

ip_addressstring

IP address of the request origin (IPv4 or IPv6). May be masked for internal UpCloud services.

resource_idstring

ID of the affected resource. May be hidden for sensitive resources like auth and account.

current_stateobject

Current state of the resource after the action (only present for create/update actions). Structure varies by resource_type.

previous_stateobject

Previous state of the resource before the action (only present for update/delete actions). Structure varies by resource_type.

Example response

{
  "time": "2024-03-05T14:30:00Z",
  "auth_type": "api",
  "cloud_event_id": "01HQXYZ123456789ABCDEFGHJK",
  "upcloud_correlation_id": "550e8400-e29b-41d4-a716-446655440000",
  "resource_type": "server",
  "action": "start",
  "origin": "api",
  "account_username": "john.doe",
  "ip_address": "192.168.1.100",
  "resource_id": "00798b85-efdc-41ca-8021-f6ef457b8531"
}

Changes

No recorded changes to this operation across all 1 revision of this API.