c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🦋 c8y(1) — the c8y manual, bestie edition 💅

okay so this is the manual page for c8y, and more specifically for the c8y events list command. it's a whole vibe, it's giving "I read the docs so you don't have to" energy. buckle up 🎀

✨ NAME ✨

c8y-events-list — get event collection. that's it. that's the whole name. iconic brevity 💅

✨ SYNOPSIS ✨

c8y events list [flags]

that's your whole incantation. c8y events list, plus whatever flags you're feeling 🌸

✨ DESCRIPTION ✨

bestie, this command grabs you a collection of events, filtered however you like via filter parameters. think of it as the events shelf at the library and you're the main character with a very specific request ✨

✨ OPTIONS ✨

here's your flag menu, no cap. every single one, and what it does 👑

  • --createdFrom="" — start date (or date and time) of when the event was created. this one's set by the platform during creation, so don't come for it 🫶
  • --createdTo="" — end date (or date and time) of when the event was created. also platform-set, also not your business to write 🌸
  • --dateFrom="" — start date or date and time of when the event actually occurred. yes, different from created. yes, that matters 💅
  • --dateTo="" — end date or date and time of when the event occurred ⭐
  • --device=[] — device ID. it also accepts pipeline input, so you can pipe it in like a boss 🔥
  • --fragmentType="" — fragment name from the event 🦋
  • --fragmentValue="" — lets you filter events by the fragment's value, but only when you provide it together with fragmentType. it's a package deal, they don't come separately 😭
  • -h, --help[=false] — help for list. your little safety net 🧚
  • --lastUpdatedFrom="" — start date or date and time of the last update made 🎀
  • --lastUpdatedTo="" — end date or date and time of the last update made 🎀
  • --revert[=false] — returns the newest events instead of the oldest. must be used with dateFrom and dateTo parameters — don't try it solo, it will not slay 🙈
  • --type="" — event type. your filter's main character moment 👑
  • --withSourceAssets[=false] — when set to true, events for related source assets get included in the request too. when this parameter is provided a source must be specified ⚠️
  • --withSourceDevices[=false] — when set to true, events for related source devices get included in the request too. same rule: when this parameter is provided a source must be specified ⚠️

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these bad boys you didn't ask for but you get anyway. they're the family heirlooms 💜

  • --abortOnErrors=10 — aborts the batch when it reaches the specified number of errors 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty is valid, okay 🫶
  • --cache[=false] — enable cached responses ⭐
  • --cacheBodyPaths=[] — limits hashing to selected paths in the json body for the cache. empty means all values 🌸
  • --cacheTTL="60s" — cache time-to-live 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 output is the terminal ✨
  • --confirm[=false] — prompt for confirmation 🙈
  • --confirmText="" — custom confirmation text, for when you wanna ask in your own words 💅
  • --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. it will NOT shut up, and that's the point 👀
  • --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 the vibes, none of the consequences 🧚
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl 🎀
  • --examples[=false] — show examples for the current command 🌟
  • --filter=[] — apply a client side filter to the response before returning it to you 🦋
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm — pick a lane bestie 😭
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue" 💌
  • --includeAll[=false] — include all results by iterating through each page. all of them. every last one 👑
  • -k, --insecure[=false] — allow insecure server connections when using SSL ⚠️
  • -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; this removes 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 🎨
  • --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 📄
  • --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 🔁
  • --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 🌸

okay these are the actually-useful ones, pay attention bestie 💖

$ c8y events list --type my_CustomType --dateFrom "-10d"
Get events with type 'my_CustomType' that were created in the last 10 days

that's you getting events of type my_CustomType created in the last 10 days. slay ✨

$ c8y events list --device 12345
Get events from a device

and that's you getting events from a device. two lines, both iconic 🫶

🎀 SEE ALSO 🎀

  • c8y-events(1) — the parent, the origin story, the mothership 👑

and that's the page!! this lil manual is from Jan 1980 (yes really, that's the date on the tin, we don't question it 💀) and it's part of the c8y(1) manual — so go forth, filter your events, and remember: --fragmentValue never travels alone 🧚‍♀️💜

📦 where this page comes from