c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the audit records list, explained by your favorite terminal bestie

okay so before we even start: this page is from the c8y manual, section 1, and it's literally just about one command — listing audit records. that's it. that's the vibe. let's go 🫶

✨ NAME ✨

c8y-auditrecords-list — get the audit record collection, bestie. that's the whole name, no notes 💅

🦋 SYNOPSIS 🦋

c8y auditrecords list [flags]

that's it. that's the whole summoning ritual. c8y, then auditrecords, then list, then whatever flags your heart desires ✨

🌸 DESCRIPTION 🌸

okay so audit records are like the receipts of your Cumulocity world 😌 they hold all the info about modifications that happened to other Cumulocity entities. it's giving "screen time report but for your infrastructure."

for example — and this is the cute part — the audit records contain each operation state transition, so you can literally use them to check when an operation transitioned from PENDING -> EXECUTING -> SUCCESSFUL. a whole little glow-up timeline, captured forever. no cap, that's genuinely useful 🔥

💖 OPTIONS 💖

these are the flags that only belong to this command. the family heirlooms come later, don't worry.

  • --application="" — filter by Application 🎀
  • --dateFrom="" — the start date, or start date and time, of when the audit record occurred. i.e. where your story begins ✨
  • --dateTo="" — the end date, or end date and time, of when the audit record occurred. the closing credits 🌙
  • -h, --help[=false] — help for list. your little safety net 🫶
  • --revert[=false] — returns the newest instead of the oldest audit records. and listen, this one is picky: it must be used with the dateFrom and dateTo parameters. no dates, no revert, periodt 💅
  • --source="" — a Source Id, or an object containing an .id property, of the element that should be detected. i.e. AlarmID, or Operation ID. ⚠️ Note: only one source can be provided (and yes, it accepts pipeline) 🦋
  • --type="" — Type 🌈
  • --user="" — Username 👑

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

the whole extended family shows up to every c8y party. every single one, listed for you, because we don't gatekeep here 💜

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. ten strikes and we're out 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. be forgiving, bestie 🎀
  • --cache[=false] — enable cached responses ⚡
  • --cacheBodyPaths=[] — the cache should limit hashing of selected paths in the json body. empty indicates all values, aka hash everything 🌀
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if the output is the terminal 🌸
  • --confirm[=false] — prompt for confirmation 🙈
  • --confirmText="" — custom confirmation text, for when you want your prompt to have personality 💅
  • --currentPage=0 — the current page which should be returned 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔧
  • --debug[=false] — set very verbose log messages. the loudest mode 🗣️
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s 😴
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s ⏱️
  • --dry[=false] — dry run. don't send any data to the server. all vibes, zero consequences ✨
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl 📝
  • --examples[=false] — show examples for the current command. yes queen, show me how it's done 👏
  • --filter=[] — apply a client side filter to the response before returning it to the user 🧚
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold of you 💥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" ✉️
  • --includeAll[=false] — include all results by iterating through each page. we're getting everything 🍓
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ caution vibes only, bestie 😭
  • -l, --logMessage="" — add a custom message to the activity log 📓
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 🔥
  • --noAccept[=false] — ignore the Accept header, which will remove the Accept header from requests; however PUT and POST requests will only see the effect 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites the cache setting) 🧊
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment 🖤
  • --noLog[=false] — disables the activity log for the current command 🔇
  • --noProgress[=false] — disable progress bars 📉
  • --noProxy[=false] — ignore the proxy settings 🚪
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops 🔁
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader 📊
  • --outputFile="" — save JSON output to file (after select/view) 💾
  • --outputFileRaw="" — save raw response to file (before select/view) 🗄️
  • --outputTemplate="" — jsonnet template to apply to the output 🎨
  • -p, --pageSize=5 — maximum results per page. five is the default, live a little 🍬
  • --progress[=false] — show progress bar. this will also disable any other verbose output 📈
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080 🌐
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off 🥩
  • --retries=3 — max number of attempts when a failed http call is encountered. three tries, then we accept fate 😌
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' 🎯
  • --session="" — session configuration 🔑
  • --sessionMode="" — override the default session mode for a single command, which would normally be disabled 🎛️
  • -P, --sessionPassword="" — override session password 🤫
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant) 🙋‍♀️
  • --silentExit[=false] — silent status codes do not affect the exit code 🤐
  • --silentStatusCodes="" — status codes which will not print out an error message 🤫
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m ⌛
  • --totalPages=0 — total number of pages to get 📚
  • -v, --verbose[=false] — verbose logging 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr 🚨
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) 🔢
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages 📖
  • --workers=1 — number of workers 👷‍♀️

🎀 EXAMPLE 🎀

here's the moment you've all been waiting for — an actual example, copied exactly, no edits, because we respect the source material:

$ c8y auditrecords list --pageSize 100
Get a list of audit records

get a list of audit records. that's what it does. iconic behavior honestly 👑

🌈 SEE ALSO 🌈

and that's the whole page, bestie!! ✨💖 this lil masterpiece is from the c8y(1) manual, dated Jan 1980 — yes, before most of us were born, and it's still slaying 💅🎀🦋

📦 where this page comes from