Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.endorlabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Field masks allow you to specify a subset of fields that each returned object includes. Similar to filter keys, a field-mask key specifies the field to return, using a dot-delimited path. The following example shows how to get just the description and severity for all findings: 
endorctl api list --resource Finding \
  --field-mask "meta.description,spec.level"

​
jq

The Endor Labs REST API returns results in json format so it is often convenient to use the jq command-line json processor to parse or format the results. The following example shows how to use jq to extract just the description value from the above request: 
endorctl api list --resource Finding \
  --field-mask "meta.description,spec.level" \
  | jq '.list.objects[].meta.description'
Lists of objects are always nested under .list.objects[], but endorctl api get returns a single object directly. To extract the object UUID from an object returned by an endorctl api get command, the jq command is jq '.uuid', as opposed to jq '.list.objects[].uuid'.
For more information, see the jq documentation.