Skip to main content
Beta endorctl API is the most user-friendly way to interact with the Endor Labs REST API. It handles authentication automatically, provides built-in error handling with clear messages, and supports multiple output formats including json, yaml, and table.

​
Prerequisites

Ensure that you complete the following prerequisites before running the commands generated by the API query builder:
  • Install the latest version of endorctl before running the commands generated by the API query builder.
  • Run endorctl init to authenticate with Endor Labs. See endorctl init for more information.

​
About the API query builder

The API query builder allows you to construct endorctl API commands based on API operations and parameters. The tool currently supports all API operations available in Top REST API Reference. You can refer to endorctl API command documentation to construct your own queries that are not supported by the API query builder. You can also refer to Use Cases and Advanced Use Cases to get examples of how you can use endorctl API commands. The tool includes options for timeouts, date filtering, and pagination. It also simplifies complex queries with easy filtering, sorting, and field selection. endorctl also supports grouping queries, which is not currently supported by the API query builder. See Grouping for more information. See the Top REST API Reference to get the details of request json for the operations that need a json request body. The request body appears in the API query builder for update operations, but you might need to modify it to fit your needs.