c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y applications update glow-up

okay bestie, so you're holding the manual page for c8y, section 1, and today's main character is c8y-applications-update. yes, the name in the NAME section is different from the page header — that's just how these pages roll, don't @ me. this one's all about tweaking an app that already exists. let's get into it ✨

🌸 NAME 🌸

c8y-applications-update — Update application details. literally just editing an app you already have, no cap.

🎀 SYNOPSIS 🎀

c8y applications update [flags]

she takes flags and flags only, bestie. no positional args, periodt.

🦋 DESCRIPTION 🦋

Update details of an existing application. that's it, that's the whole vibe. you point her at an app and tell her what to change. iconic 🫶

✨ OPTIONS ✨

  • --availability="" — access level for other tenants. possible values are: MARKET, PRIVATE (default). so like, do you want everyone to see it or is it giving private story energy 👀
  • --contextPath="" — the contextPath of the hosted application.
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. shorthand is such a slay, ngl.
  • --externalUrl="" — URL to the external application.
  • -h, --help[=false] — help for update. your little safety net 💖
  • --id="" — application id (required) (accepts pipeline). yes it's required, don't forget her, she's the main character.
  • --key="" — shared secret of application. keep it secret, keep it safe 🔐
  • --name="" — name of application.
  • --processingMode="" — Cumulocity processing mode.
  • --resourcesPassword="" — authorization password to access resourcesUrl.
  • --resourcesUrl="" — URL to application base directory hosted on an external server.
  • --resourcesUsername="" — authorization username to access resourcesUrl.
  • --template="" — body template.
  • --templateVars=[] — body template variables.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the hand-me-downs, and honestly they ate. every single one is available here too:

  • --abortOnErrors=10 — abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). the gentlest girlie of them all.
  • --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. she's loud and we love her 💀
  • --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. practice mode, no 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 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. bestie, be careful with this one 🙈
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). she said caution, so like, 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 🔥

this is the part where it all clicks, watch:

$ c8y applications update --id "my-example-app" --availability MARKET
Update application availability to MARKET

see? told you. she took the id, flipped availability to MARKET, done. ate and left no crumbs 💅

🌈 SEE ALSO 🌈

c8y-applications(1) — go say hi to the parent, she's the whole ecosystem 🧚

real talk though bestie: --id is required, so if you forget it she will simply not function. and PRIVATE is the default for --availability, so nothing happens to your visibility unless you say so. 💖

that's the whole page, fr fr. this doc came to you from the c8y(1) crew, dated Jan 1980 (yes, really, she's vintage 👑), and she signs off the way she always does — c8y(1), page one of the manual, twenty-four hours a day, slaying. 🎀✨

📦 where this page comes from