c8y(1)

📦 version 2.56.1, in nixpkgs unstable

hiii bestie 💖 welcome to the c8y(1) manual page — specifically the c8y api command, and yes it’s giving main character energy. We’re sending authenticated API requests, keeping every flag, and not skipping a single detail. periodt ✨

🌸 NAME 🌸

c8y-api — send api request

🦋 SYNOPSIS 🦋

c8y api [flags]

✨ DESCRIPTION ✨

Sends an authenticated API request to the endpoint you give it. That’s the whole vibe: you point, it sends, slay 💅

🎀 OPTIONS 🎀

  • --accept="" — accept (header)
  • --contentType="" — content type (header)
  • -d, --data=[] — static data that gets applied to the body; accepts JSON or shorthand JSON, i.e. --data 'value1=1,my.nested.value=100'
  • --file="" — file to be uploaded as a binary
  • --formdata="" — form data (JSON or shorthand JSON)
  • -h, --help[=false] — help for api
  • --host="" — host to use for the REST request; if it’s empty, then the session’s host will be used
  • --keepProperties[=true] — don’t strip Cumulocity properties from the data property, i.e. source etc.
  • --method="GET" — HTTP method
  • --template="" — body template
  • --templateVars=[] — body template variables
  • --url="" — URL path; any reference to '%s' will be replaced with the current input value (accepts pipeline)

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

No gatekeeping here — these come from the parent commands and they’re all still part of the menu, bestie:

  • --abortOnErrors=10 — abort batch when reaching the 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 the 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 the Accept header; this 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 🌈

Okay bestie, examples are where it gets iconic. Here’s every single one, no skips:

$ c8y api GET /alarm/alarms

Get a list of alarms ✨

$ c8y api GET "/alarm/alarms&status=ACTIVE" --pageSize 10

Get a list of alarms with custom query parameters.

$ c8y api GET "/dosomething" --host localhost:8080

Send a GET request to a custom hosted service running on localhost port 8080. You can force https or http by adding them as a prefix to the host.

$ c8y api GET "/dosomething" --host $C8Y_HOST/service/mymicroservice --dry

Send a request to a microservice hosted in the cloud. The /dosomething will be appended to the /service/mymicroservice path provided by the host flag. Results in the following request: GET /service/mymicroservice/dosomething sent to the current session URL.

$ c8y api GET "/alarm/alarms&status=ACTIVE" --pageSize 1 --withTotalPages

Get a total ACTIVE alarms.

$ c8y api POST "alarm/alarms" --data "text=one,severity=MAJOR,type=test_Type,time=2019-01-01,source.id='12345'" --keepProperties

Create a new alarm.

$ c8y activitylog list --filter "method like POST" | c8y api --method DELETE

Get items created via POST from the activity log and delete them.

$ echo -e "/inventory/1111\n/inventory/2222" | c8y api --method PUT --template "{myScript: {lastUpdated: _.Now() }}"

Pipe a list of urls and execute HTTP PUT and use a template to generate the body.

$ echo "12345" | c8y api PUT "/service/example" --template "{id: input.value}"

Send a PUT request to a fixed url, but use the piped input to build the request’s body.

$ echo "12345" | c8y api PUT "/service/example/%s" --template "{id: input.value}"

Send a PUT request using the piped input in both the url and the request’s body ('%s' will be replaced with the current piped input line).

$ echo "{\"url\": \"/service/custom/endpoint\",\"body\":{\"name\": \"peter\"}}" | c8y api POST --template "input.value.body"

Build a custom request using piped json. The input url property will be mapped to the --url flag, and use a template to also build the request’s body from the piped input data.

💜 SEE ALSO 💜

okay that’s the whole page bestie — stamped Jan 1980 and filed under c8y(1). now go make some authenticated API requests, slay 💅✨

📦 where this page comes from