c8y(1)

📦 version 2.56.1, in nixpkgs unstable

✨ c8y(1) ✨

hey bestie! 💖 this is the manual page for the c8y command—yes, that c8y, the Cumulocity CLI that's literally the main character of your terminal. buckle up, we're diving into c8y-events-delete and it's giving "clean up your event situation" energy. 🧹✨

🦋 NAME 🦋

c8y-events-delete — delete an event, periodt. 💅 you want an event gone? this is how you do it, no cap.

🌸 SYNOPSIS 🌸

c8y events delete [flags]

that's the whole vibe. you run this bad boy with some flags and the event is outta there. 🫶

💜 DESCRIPTION 💜

so like, you have an existing event in Cumulocity and you're just done with it? we've all been there. 🙈 this command literally deletes it. that's the whole thing. no complicated lore, just pure "bye bestie" energy. 🔥

🎀 OPTIONS 🎀

okay so here are the options that are specific to this command—like, the ones that make delete do its delete thing. 👑

  • -h, --help[=false] — shows help for delete. classic. you love to see it. 💖
  • --id=[] — the event id, and it's required (no cap!). also accepts pipeline input, so you can pipe it in like a pro. 🎯
  • --processingMode="" — the Cumulocity processing mode. you know, for when you're feeling fancy with your processing. ✨

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these are the options you get from the parent command because apparently deleting one event wasn't enough and you need all the power. iykyk. 💅

  • --abortOnErrors=10 — abort batch when reaching the specified number of errors. like, if 10 things go wrong, we're out. 💀
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). sometimes the void is okay, bestie. 🌈
  • --cache[=false] — enable cached responses. speed things up, you know? ⭐
  • --cacheBodyPaths=[] — limits what gets hashed in the json body for cache. empty means all values, so if you leave it blank it's like "everything, go off." 🦋
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration. like 60s or 2m. think of it as how long the cache stays fresh before it gets stale. 🍓
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal, but if you want it all squished together, this is your moment. 🎀
  • --confirm[=false] — prompt for confirmation. gives you that "are you sure?" moment. 🙈
  • --confirmText="" — custom confirmation text. make it say whatever you want, honestly iconic. 💅
  • --currentPage=0 — current page which should be returned. you know, for pagination vibes. 📄
  • --customQueryParam=[] — add custom URL query parameters. like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. go wild. 🌈
  • --debug[=false] — set very verbose log messages. debug mode: on, chaos: manageable. 🔥
  • --delay="0ms" — delay after each request. like 5ms or 1.2s. give the server a lil breather. 😮‍💨
  • --delayBefore="0ms" — delay before each request. same energy, but before. ⏳
  • --dry[=false] — dry run. don't send any data to the server. just pretend. 💭
  • --dryFormat="markdown" — dry run output format. like json, dump, markdown or curl. pick your aesthetic. 🎨
  • --examples[=false] — show examples for the current command. because who doesn't love examples? ✨
  • --filter=[] — apply a client side filter to response before returning it to the user. like a little sieve for your data. 🧚
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. basically, make it all flat like a pancake. 🥞
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. you're the boss. 👑
  • -H, --header=[] — custom headers. like --header "Accept: value, AnotherHeader: myvalue". flex those HTTP muscles. 💪
  • --includeAll[=false] — include all results by iterating through each page. because sometimes you want everything. 💖
  • -k, --insecure[=false] — allow insecure server connections when using SSL. live dangerously, but like, securely? sort of. ⚠️
  • -l, --logMessage="" — add custom message to the activity log. leave your mark. ✍️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). unlimited power, but with great power comes great "maybe don't." 💀
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. HTTP header drama, honestly. 🙄
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). no cache, no problem. 🚫
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. some people like it monochrome, and that's valid. 🖤
  • --noLog[=false] — disables the activity log for the current command. no receipts, no evidence. 🤫
  • --noProgress[=false] — disable progress bars. sometimes you just don't want to see the loading. 🤷‍♀️
  • --noProxy[=false] — ignore the proxy settings. go direct, bestie. 🛣️
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. when you need to be left alone. 🚪
  • -o, --output="table" — output format. like table, json, csv, csvheader. pick your poison. 📊
  • --outputFile="" — save JSON output to file (after select/view). for when you need receipts. 📁
  • --outputFileRaw="" — save raw response to file (before select/view). the unfiltered truth. 📜
  • --outputTemplate="" — jsonnet template to apply to the output. fancy formatting, love that. ✨
  • -p, --pageSize=5 — maximum results per page. 5 is the default, but you do you. 📖
  • --progress[=false] — show progress bar. this will also disable any other verbose output. visual feedback, yay! 🎬
  • --proxy="" — proxy setting. like http://10.0.0.1:8080. for when you need to go through the middleman. 🕵️‍♀️
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. no filter, no chill. 😎
  • --retries=3 — max number of attempts when a failed http call is encountered. 3 tries, then we give up. 🤷‍♀️
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, like --select 'id,name,type,**.serialNumber'. you get to choose what you see. 🔍
  • --session="" — session configuration. because sessions are a whole thing. 🪄
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. breaking the rules, respectfully. 💅
  • -P, --sessionPassword="" — override session password. your secret, your rules. 🤫
  • -U, --sessionUsername="" — override session username. like peter or t1234/peter (with tenant). know your username, bestie. 👤
  • --silentExit[=false] — silent status codes do not affect the exit code. it's exit code neutrality. ☮️
  • --silentStatusCodes="" — status codes which will not print out an error message. for when you just don't want to hear about it. 🙉
  • --timeout="600s" — request timeout duration. like 60s or 2m. 600s is the default, so it's pretty patient. ⏰
  • --totalPages=0 — total number of pages to get. 0 means... well, it's 0. 📚
  • -v, --verbose[=false] — verbose logging. because sometimes you need all the details. 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. automatic viewing, iconic. 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. error drama, but on a different channel. 📢
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). know your totals. 🔢
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. page math, love that for us. 📄
  • --workers=1 — number of workers. 1 is the default, so it's a solo mission unless you say otherwise. 👯‍♀️

🌟 EXAMPLE 🌟

okay here's the moment you've been waiting for—the example! ✨

$ c8y events delete --id 12345
Delete an event

like, yes bestie, delete that event. --id 12345 and you're done. no cap, that's the whole thing. 🎉

🫶 SEE ALSO 🫶

c8y-events(1) — the parent command, the big boss. go check it out if you want more event action. 💖

alright bestie, that's the tea on c8y-events-delete! ☕💅 go forth and delete events like the iconic unix girlboss you are! 🌈✨

signing off from Jan 1980 (yes, really) — c8y(1) 🎀🦋💜

📦 where this page comes from