Skip to main content

​
Overview

Control Plane provides a tamper-proof audit trail service for both Control Plane and custom workload actions. To use this feature, create a unique audit context for your workload. The cpln audit context is pre-provisioned and captures all native Control Plane platform activity. See the audit trail reference page for details on how to query the audit trail and securely capture actions for your workloads.

​
Create an Audit Context

See the Create an Audit Context guide for setup instructions.

​
Permissions

The following permissions can be assigned through policies to supported principal types:
PermissionDescriptionImplies
createCreate new contexts
editModify existing contextsview
manageFull accesscreate, edit, manage, readAudit, view, writeAudit
readAuditRead from this contextview
viewRead-only view
writeAuditWrite to this contextview

​
Access Report

Displays the permissions granted to principals for the audit context.

​
Writing Audit Records from a Workload

  1. Make sure the workload is assigned an identity that is granted writeAudit permission on the target audit context.
  2. Write events using the internal audit endpoint: 
    # Minimal example
curl -H "Content-Type: application/json" -X POST http://127.0.0.1:43000/audit/org/${CPLN_ORG}/auditctx/custom-audit-context?async=true -d '{"resource": {"id": "anyid123", "type": "anytype"}}'

​
CLI

To view the CLI documentation for audit contexts, see the Audit Context CLI reference.