endorctl CLI exit codes

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

endorctl exit codes provide an outcome of the program’s execution, indicating whether it was completed successfully or encountered an error. Check the following exit codes to determine the next steps based on the outcome. 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.

ENDORCTL_RC_ERROR = 2

The exact reason for the error can not be determined.

ENDORCTL_RC_INVALID_ARGS = 3

An invalid argument is provided in the endorctl utility. This may occur due to invalid endorctl commands, or a package format is incorrect. Check the commands and their arguments and try again.

ENDORCTL_RC_ENDOR_AUTH_FAILURE = 4

endorctl does not have the correct authentication permissions to perform the given operation. Check the Endor Labs API keys or tokens to make sure they are valid and include the necessary permissions.

ENDORCTL_RC_DOCTOR_FAILURE = 5

The doctor checks in endorctl checks if the user’s environment is properly set up and configured for the given endorctl command. Something went wrong with these checks resulting in this error. Check the error message and logs for more details.

ENDORCTL_RC_GITHUB_AUTH_FAILURE = 6

The user has provided an empty or invalid GitHub token resulting in this error. They can provide a token using --github-token flag or through the environment variable GITHUB_TOKEN. You can choose to skip the GitHub scanner by not setting the --github flag.

ENDORCTL_RC_ANALYTICS_ERROR = 7

The project data could not be processed and the generated findings may be incomplete.

ENDORCTL_RC_FINDINGS_ERROR = 8

The project data could not be processed and resulted in an error to generate findings.

ENDORCTL_RC_NOTIFICATIONS_ERROR = 9

There is an error associated with a configured notification policy. Check the configured notification policy and try again.

ENDORCTL_RC_GITHUB_API_ERROR = 10

There is an error associated with GitHub APIs. This could occur due to:

  • The repository information is not fetched from Github. It could be due to reasons such as a context deadline being exceeded, or you might hit the rate limits.
  • Unable to synchronize and fetch the list of repositories for a given organization using the endorctl sync-org command. Try to initiate the scan again after some time.

ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR = 11

The provided GitHub token does not have enough permissions to perform the given operation resulting in this error. Check the log message to see what object is causing the issue.

ENDORCTL_RC_GIT_ERROR = 12

A git operation has failed in endorctl resulting in this error. A few common points of error can include operations such as cloning, opening, finding the root, finding the HEAD, finding the default branch, and more. Ensure you are inside the correct git repository and that it is properly set up for the scan.

ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR = 13

There is an error while resolving the dependencies of the current project.

ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR = 14

There is an error while scanning or storing resolved dependencies.

ENDORCTL_RC_CALL_GRAPH_ERROR = 15

There is an error while generating call graphs.

ENDORCTL_RC_LINTER_ERROR = 16

There is an error while running the linter to analyze the source code. This can affect secret and vulnerability detection.

ENDORCTL_RC_BAD_POLICY_TYPE = 17

There is an issue with a user-defined policy. Check the log to fetch policy details.

ENDORCTL_RC_POLICY_ERROR = 18

There is an issue while evaluating one or more policies. Check the log to fetch policy details.

ENDORCTL_RC_INTERNAL_ERROR = 20

There is an error within the endorctl utility.

ENDORCTL_RC_DEADLINE_EXCEEDED = 21

A time-out has occurred while executing a given command. Try to scan again after some time.

ENDORCTL_RC_NOT_FOUND = 22;

The requested entity is not found resulting in this error.

ENDORCTL_RC_ALREADY_EXISTS = 23

An attempt to create an entity has failed as it already exists.

ENDORCTL_RC_UNAUTHENTICATED = 24

The system was not able to authenticate this request resulting in this error.

ENDORCTL_RC_VULN_ERROR = 25

There is an issue with ingesting and processing vulnerability data. Check the logs for more details.

ENDORCTL_RC_POLICY_VIOLATION = 128

One or more policies that the user has set up are violated. Check the error logs to see which policies are violated.

ENDORCTL_RC_POLICY_WARNING = 129

One or more policies set up to warn the user are violated. Check the error logs to see which policies are violated. This error code is only displayed if the flag --exit-on-policy-warning is set to true.