c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — the notification2 unsubscribe glow-up 💖

okay bestie, so this is the c8y manual page, and specifically the c8y-notification2-tokens-unsubscribe one. it's giving "goodbye to a subscriber that's never coming back" energy. no cap, let's get into it 🫶

✨ NAME ✨

c8y-notification2-tokens-unsubscribe — unsubscribe via a token, periodt.

🦋 SYNOPSIS 🦋

c8y notification2 tokens unsubscribe [flags]

🌸 DESCRIPTION 🌸

so you want to unsubscribe a notification subscriber using the notification token. iconic. here's the tea: once a subscription is made, notifications will be kept until they are consumed by all subscribers who have previously connected to the subscription. literally holding onto them for you.

for non-volatile subscriptions, this can result in notifications remaining in storage if never consumed by the application. yep, just sitting there. they will be deleted if a tenant is deleted. and it can take up considerable space in permanent storage for high-frequency notification sources. not the vibe for your storage bills. therefore, we recommend you to unsubscribe a subscriber that will never run again. lowkey good advice, highkey important 💅

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for unsubscribe. the classic lil helper.
  • --processingMode="" — Cumulocity processing mode. you know, the mode of processing.
  • --token="" — Subscriptions associated with this token will be removed. required, bestie, and it accepts pipeline. no token, no slay.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

this is the long list of parent-command options, and yes, we're going through every single one because nobody gets left behind. fr fr.

  • --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!). ⚠️ seriously, 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. sad but sometimes necessary.
  • --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 🌈

like, actual proof it works:

$ c8y notification2 tokens unsubscribe --token "eyJhbGciOiJSUzI1NiJ9"
Unsubscribe a subscriber using its token

ate. no crumbs. 💅

🔥 SEE ALSO 🔥

c8y-notification2-tokens(1) — go check out the parent, iykyk.

okay that's the whole thing, bestie. you're now officially fluent in c8y notification2 tokens unsubscribe. go forth and unsubscribe responsibly. mwah 🫶💖

this page is from the c8y manual, dated Jan 1980, and the footer says source/version and date — consider this the cute lil sign-off: stay slaying, stay subscribed to the good stuff, and remember to clean up your tokens. bye bestie! 🎀✨

📦 where this page comes from