c8y(1)

okay so bestie, welcome to the c8y(1) manual page — we're zooming in on c8y agents delete, and yes, this is the same c8y(1) from the header, just folded in here so it doesn't ghost us at the top 💖

🌸 NAME 🌸

c8y-agents-delete — Delete agent ✨

✨ SYNOPSIS ✨

c8y agents delete [flags]

💖 DESCRIPTION 💖

Delete an agent from the platform. This will delete all data associated to the agent (i.e. alarms, events, operations and measurements).

🚨 bestie, real talk: this is the “delete the whole vibe” button. It deletes the agent and all data associated to it — alarms, events, operations and measurements, all of it. 💀

🎀 OPTIONS 🎀

• --cascade[=false] — remove all child devices, and child assets get deleted recursively. By default, the delete operation is propagated to the subgroups only if the deleted object is a group 🫶
• -h, --help[=false] — help for delete 💅
• --id=[] — Agent ID (required) (accepts pipeline) 👑
• --processingMode="" — Cumulocity processing mode 🌀
• --withDeviceUser[=false] — Delete associated device owner 🧚

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these come from the parent commands, so they're not unique to delete, but they're still invited to the group chat:

• --abortOnErrors=10 — abort batch when reaching specified number of errors 🛑
• --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin) 🫧
• --cache[=false] — enable cached responses 💾
• --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. Empty indicates all values 🔍
• --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 output is the terminal 🧃
• --confirm[=false] — prompt for confirmation 🙋‍♀️
• --confirmText="" — custom confirmation text 💬
• --currentPage=0 — 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 🐛
• --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 🧪
• --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 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 🪄
• -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm 💥
• -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
• --includeAll[=false] — include all results by iterating through each page 📚
• -k, --insecure[=false] — allow insecure server connections when using SSL 🔓
• -l, --logMessage="" — add custom message to the activity log 🗒️
• --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) ⚠️
• --noAccept[=false] — ignore Accept header 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 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 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 🌈

$ c8y agents delete --id 12345
Get agent by id

$ c8y agents delete --id agent01
Get agent by name

$ c8y agents delete --id 12345 --withDeviceUser
Delete agent and related device user/credentials

👑 SEE ALSO 👑

c8y-agents(1)

and that's the whole page, bestie — manual: c8y(1), dated Jan 1980, periodt 🎀💅✨