endorctl API Query Builder

Use our API-based query builder to construct endorctl commands based on actual API operations and parameters.

Alpha

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.

You can refer to the Top REST API Reference to get the details of request parameters for the particular endpoints that need a json request body. The request body appears in the API query builder, but you must modify it to fit your needs.

Endor Labs API Query Builder

Build endorctl API commands. Select a service, operation, and configure parameters.

Service

Operation

Namespace

Resource Identifier

UUID or name of the resource:
• UUID: The unique identifier of the resource you want to access
• Name: The name of the resource (for example, project name)
• Example: my-project or 123e4567-e89b-12d3-a456-426614174000

Output Format

Choose the output format for the response

List Parameters

Filters

Filter which records to find: Specify criteria to match records.
Example: spec.level == FINDING_LEVEL_CRITICAL - Find only critical findings
meta.name refers to the selected resource's name field

Field Mask

Control which fields to display: Comma-separated list of fields to return.
For example, uuid,meta.name,spec.level. Shows only UUID, name, and severity level. (for example, "name and level only")
Use this to reduce response size and focus on relevant data

Page Size

Control response size: Number of results per page (max 500).
Smaller values = faster responses, larger values = fewer API calls
Cannot be used together with "Count only"

Page Token

Page number to retrieve
Cannot be used together with "Count only"

Sort Field

Sort Order

Count only

Returns only the total count of matching records, not the actual data
Cannot be used together with "Page Size" or "Page Token"

Include child namespaces

Timeout

Request timeout (default: 20s). Use format like "30s", "2m", "1h"

From Date

Filter records created after this date

To Date

Filter records created before this date

Update Fields Select which fields you want to update. Only selected fields will be included in the update_mask.

Update Mask: No fields selected

Request Body

JSON to create or update the resource. Modify the JSON to fit your needs.

Feedback

Was this page helpful?

Thanks for the feedback. Write to us at support@endor.ai to tell us more.