c8y(1)

📦 version 2.56.1, in nixpkgs unstable

okay bestie, you opened the c8y manual page (that's the manual name — c8y, section 1, the whole vibe) and honestly? you're about to understand the Cumulocity databroker situation. stay with me, it's gonna slay 💅

🌸 NAME

c8y-databroker — literally the Cumulocity databroker. no cap, that's it, that's the name 🫶

✨ SYNOPSIS

c8y databroker [flags]

🦋 DESCRIPTION

it's the REST endpoint you use to interact with the Cumulocity databroker. that's the whole job, and it does it iconically 👑

🎀 OPTIONS

  • -h, --help[=false] — bestie, help for databroker. it tells you about databroker. love that for us 💖

🌈 OPTIONS INHERITED FROM PARENT COMMANDS

okay so this is the long part, but every single one of these is inherited from the parent commands and you're gonna want all of them, so let's go, no skipping 🧚

  • --abortOnErrors=10 — abort the batch once you hit the specified number of errors. default is 10, so ten strikes and the batch is out 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. default is false, meaning empty pipe = sad. set it and it's chill 🍓
  • --cache[=false] — enable cached responses. off (false) unless you say otherwise ✨
  • --cacheBodyPaths=[] — the cache should only hash these selected paths in the json body. empty (the default []) means all values get hashed 🔥
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default is "60s" ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. important: pretty print is the default if the output is the terminal 💅
  • --confirm[=false] — prompt for confirmation. default false 💖
  • --confirmText="" — custom confirmation text. default is the empty string "" 🫶
  • --currentPage=0 — current page which should be returned. default 0 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. default [] 🔗
  • --debug[=false] — set very verbose log messages. the "what is happening" mode 🐛
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default "0ms" 😴
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default "0ms" 😴
  • --dry[=false] — dry run. don't send any data to the server. so brave 🙈
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. default "markdown" 📝
  • --examples[=false] — show examples for the current command. yes queen, show us 🙌
  • --filter=[] — apply a client side filter to the response before returning it to the user. default [] 🧹
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. default false 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm ⚠️ (fr fr, --confirm wins)
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". default [] 📨
  • --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. okay risky icon, use with intention 🔓
  • -l, --logMessage="" — add a custom message to the activity log. default "" 💬
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). caution noted, bestie 😭
  • --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). it beats --cache, periodt 😤
  • -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. no little bars for you 🚫
  • --noProxy[=false] — ignore the proxy settings 🕵️
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. loops say thank you 🔁
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. default "table" 📊
  • --outputFile="" — save JSON output to file (after select/view). default "" 💾
  • --outputFileRaw="" — save raw response to file (before select/view). default "" 🗃️
  • --outputTemplate="" — jsonnet template to apply to the output. default "" 🧵
  • -p, --pageSize=5 — maximum results per page. default is 5, tiny little pages 🎀
  • --progress[=false] — show progress bar. heads up: this will also disable any other verbose output 🚦
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. default "" 🌐
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. no negotiating 😌
  • --retries=3 — max number of attempts when a failed http call is encountered. default 3, we try three times 💪
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' ✨
  • --session="" — session configuration. default "" 🔐
  • --sessionMode="" — override the default session mode for a single command which would normally be disabled. default "" 🎭
  • -P, --sessionPassword="" — override session password. default "" 🤫
  • -U, --sessionUsername="" — override session username, i.e. peter or t1234/peter (with tenant). default "" 🧑‍💻
  • --silentExit[=false] — silent status codes do not affect the exit code. default false 🤐
  • --silentStatusCodes="" — status codes which will not print out an error message. default "" 🙊
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. default "600s" ⏰
  • --totalPages=0 — total number of pages to get. default 0 📚
  • -v, --verbose[=false] — verbose logging. say more 🔍
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. default "auto" 🖼️
  • --withError[=false] — errors will be printed on stdout instead of stderr. plot twist 👀
  • --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. default 1, one hardworking little worker bee 🐝

💜 SEE ALSO

and that's the page, bestie!! 🫶 source/version line says c8y(1) and it's dated Jan 1980 (yes, really, she's vintage 💀). go forth and databroke-nothing, mwah 💋🌈

📦 where this page comes from