This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

endorctl CLI exit codes

Learn about the exit codes that you may encounter while using the endorctl CLI.

The endorctl exit codes provide the result of the program’s execution, indicating whether it was completed successfully or encountered an error. This page documents the possible endorctl exit code values and the recommended next steps. When contacting support, provide the error code and the error message to help us debug the issue.

To get the exit code, run echo $? on the command line prompt.

Value Exit Code Name Description
2 ENDORCTL_RC_ERROR The exact reason for the error could not be determined.
3 ENDORCTL_RC_INVALID_ARGS An invalid argument was provided. This may occur due to an invalid parameter value, or an incorrect package format.
4 ENDORCTL_RC_ENDOR_AUTH_FAILURE The user does not have the correct permissions to perform the given operation. Check the Endor Labs token or API keys to make sure they are valid and include the necessary permissions. These are provided using the --token flag or through the environment variables ENDOR_TOKEN, or ENDOR_API_CREDENTIALS_KEY/SECRET. Note that the environment variables are mutually exclusive, that is you cannot have both a token and API keys set at the same time.
6 ENDORCTL_RC_GITHUB_AUTH_FAILURE The user has provided an empty or invalid GitHub token. This token is provided using the --github-token flag or through the environment variable GITHUB_TOKEN. You can skip the GitHub scan by not setting the --github flag.
7 ENDORCTL_RC_ANALYTICS_ERROR There was an error analyzing the dependencies.
8 ENDORCTL_RC_FINDINGS_ERROR There was an error generating findings based on the analytics output.
9 ENDORCTL_RC_NOTIFICATIONS_ERROR There was an error processing a notification triggered by a notification policy. See the error log for details and verify that the corresponding notification target is set up correctly.
10 ENDORCTL_RC_GITHUB_API_ERROR An error was returned by the GitHub API. This can occur due to GitHub rate-limiting or context deadline exceeded. Check the log message to see what object is causing the issue.
11 ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR This error typically occurs when the user is authenticated with GitHub, but does not have the necessary permissions to perform the requested operation. It indicates that the user is forbidden from accessing the requested resource due to insufficient permissions. Check the GitHub token permissions, as well as the permissions and user accounts associated with the repository and/or organization and try again.
12 ENDORCTL_RC_GIT_ERROR A git operation has failed. Examples of git operations are: Cloning, opening, finding the root, finding the HEAD, finding the default branch, and more. Ensure you are scanning the correct git repository and that it is properly set up for the scan.
13 ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR There was an error resolving the dependencies.
14 ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR There was an error processing the resolved dependencies.
15 ENDORCTL_RC_CALL_GRAPH_ERROR There was an error generating the call graph.
16 ENDORCTL_RC_LINTER_ERROR There was an error while running the linter(s) used to analyze the source code. This can affect secret and vulnerability detection.
17 ENDORCTL_RC_BAD_POLICY_TYPE An invalid policy was detected. Note that this is not a fatal error, but the policy in question was not processed. See log for details.
18 ENDORCTL_RC_POLICY_ERROR There was an error evaluating one or more policies. See log for details.
20 ENDORCTL_RC_INTERNAL_ERROR There was an internal error within endorctl. See log for details.
21 ENDORCTL_RC_DEADLINE_EXCEEDED The deadline expired before the operation could complete.
22 ENDORCTL_RC_NOT_FOUND The requested resource was not found.
23 ENDORCTL_RC_ALREADY_EXISTS An attempt to create an entity failed because a resource with the same key already exists.
24 ENDORCTL_RC_UNAUTHENTICATED The request does not have valid authentication credentials for the operation.
25 ENDORCTL_RC_VULN_ERROR There was an issue ingesting and processing vulnerability data. See log for details.
26 ENDORCTL_RC_INITIALIZATION_ERROR There was an error initializing the project or the repository. This can happen if the project ingestion token is missing, the project URL is invalid, or authorization failed. See log for details.
27 ENDORCTL_RC_HOST_CHECK_FAILURE The endorctl host-check failed. Host will not be able to run endorctl scan successfully. See log for details.
28 ENDORCTL_RC_SBOM_IMPORT_ERROR There was an error importing an SBOM. See log for details.
29 ENDORCTL_RC_PRE_COMMIT_CHECK_FAILURE The pre-commit-checks command discovered one or more leaked secrets. See log for details.
30 ENDORCTL_RC_GH_ACTION_WORKFLOW_SCAN_FAILURE There was an error scanning the GitHub action dependencies. See log for details.
31 ENDORCTL_RC_FILE_ANALYTICS_ERROR There was an error reading files for analytics processing. See log for details.
32 ENDORCTL_RC_SIGNATURE_VERIFICATION_FAILURE Signature verification failed. See log for details.
33 ENDORCTL_RC_LICENSE_ERROR The requested operation requires additional licensing. See log for details.
128 ENDORCTL_RC_POLICY_VIOLATION One or more “blocking” admission policies were violated. See log for details.
129 ENDORCTL_RC_POLICY_WARNING One or more “warning” admission policies were violated. This error code is only returned if the --exit-on-policy-warning flag is set.