ListSemgrepRules - Endor Labs Documentation

{ "count_response": { "count": 123 }, "group_response": { "groups": {} }, "list": { "objects": [ { "meta": { "name": "<string>", "annotations": {}, "create_time": "2023-11-07T05:31:56Z", "created_by": "<string>", "description": "<string>", "index_data": { "data": [ "<string>" ], "search_score": 123, "tenant": "<string>", "will_be_deleted_at": "2023-11-07T05:31:56Z" }, "kind": "<string>", "parent_kind": "<string>", "parent_uuid": "<string>", "references": {}, "tags": [ "<string>" ], "update_time": "2023-11-07T05:31:56Z", "updated_by": "<string>", "upsert_time": "2023-11-07T05:31:56Z", "version": "<string>" }, "spec": { "defined_by": "<string>", "disabled": true, "rule": { "fix": "<string>", "fix_regex": { "count": 123, "regex": "<string>", "replacement": "<string>" }, "focus_metavariable": [ "<string>" ], "id": "<string>", "languages": [ "<string>" ], "message": "<string>", "metadata": { "ai_provider": "<string>", "asvs": { "control_id": "<string>", "control_url": "<string>", "section": "<string>", "version": "<string>" }, "author": "<string>", "bandit_code": "<string>", "category": "<string>", "confidence": "<string>", "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED", "cwe": [ "<string>" ], "cwe2020_top25": true, "cwe2021_top25": true, "cwe2022_top25": true, "cwe2023_top25": true, "deprecated": true, "description": "<string>", "display_name": "<string>", "endor_attack_examples": [ "<string>" ], "endor_category": "<string>", "endor_rule_origin": { "license": "<string>", "url": "<string>" }, "endor_tags": [ "<string>" ], "endor_targets": [ "ENDOR_TARGET_UNSPECIFIED" ], "explanation": "<string>", "functional_categories": [ "<string>" ], "help": "<string>", "impact": "<string>", "interfile": true, "license": "<string>", "likelihood": "<string>", "masvs": [ "<string>" ], "owasp": [ "<string>" ], "owaspapi": "<string>", "precision": "<string>", "references": [ "<string>" ], "remediation": "<string>", "resources": [ "<string>" ], "rule_origin_note": "<string>", "security_severity": "<string>", "severity": "<string>", "short_description": "<string>", "source_rule_url": "<string>", "source_url_open": "<string>", "subcategory": [ "<string>" ], "tags": [ "<string>" ], "technology": [ "<string>" ], "version": "<string>", "vulnerability": "<string>", "vulnerability_class": [ "<string>" ] }, "metavariable_pattern": { "language": "<string>", "metavariable": "<string>", "pattern": "<string>", "pattern_either": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_regex": "<string>", "patterns": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ] }, "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "min_version": "<string>", "mode": "<string>", "options": { "constant_propagation": true, "generic_ellipsis_max_span": 123, "generic_engine": "<string>", "implicit_deep_exprstmt": true, "interfile": true, "symbolic_propagation": true, "taint_assume_safe_booleans": true, "taint_assume_safe_functions": true, "taint_assume_safe_numbers": true, "taint_unify_mvars": true }, "paths": { "exclude": [ "<string>" ], "include": [ "<string>" ] }, "pattern": "<string>", "pattern_either": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_inside": "<string>", "pattern_inside_either": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_not": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_propagators": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_regex": "<string>", "pattern_sanitizers": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_sinks": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "pattern_sources": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "patterns": [ { "by_side_effect": true, "exact": true, "focus_metavariable": [ "<string>" ], "from": "<string>", "label": "<string>", "management": { "endpoints": { "web": { "exposure": { "exclude": [ "<string>" ], "include": [ "<string>" ] } } } }, "metavariable_analysis": { "analyzer": "<string>", "metavariable": "<string>" }, "metavariable_comparison": { "base": true, "comparison": "<string>", "metavariable": "<string>", "strip": true }, "metavariable_pattern": "<unknown>", "metavariable_regex": { "metavariable": "<string>", "regex": "<string>", "x": "<string>" }, "metavariable_type": { "metavariable": "<string>", "type": "<string>" }, "not_conflicting": true, "pattern": "<string>", "pattern_either_new": "<array>", "pattern_inside": "<string>", "pattern_inside_either": "<array>", "pattern_not": "<string>", "pattern_not_inside": "<string>", "pattern_not_regex": "<string>", "pattern_regex": "<string>", "patterns": "<array>", "requires": "<string>", "to": "<string>" } ], "references": [ "<string>" ], "severity": "<string>" }, "severity_level": "SEVERITY_LEVEL_UNSPECIFIED", "yaml": "<string>" }, "disabled": true, "propagate": true, "tenant_meta": { "namespace": "<string>" }, "uuid": "<string>" } ], "response": { "next_page_id": "<string>", "next_page_token": 123 } } }

Path Parameters

tenant_meta.namespace

string

required

Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app".

Query Parameters

list_parameters.filter

string

String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses.

Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")".

list_parameters.page_token

integer<int32>

Set the page token to start from. Use page tokens to page through list results or list specific pages.

list_parameters.page_size

integer<int32>

Set the page size to limit the number of results returned. Default: 100. Max: 500.

list_parameters.action

string

Action to be executed with a request. Not supported for all endpoints.

list_parameters.mask

string

List of fields to return (all fields are returned by default).

list_parameters.traverse

boolean

Get data from any child namespaces as well.

list_parameters.sort.path

string

Field to sort objects by, for example, meta.name.

list_parameters.sort.order

enum<string>

default:SORT_ENTRY_ORDER_UNSPECIFIED

Sort order. Default: ASC.

Available options:

SORT_ENTRY_ORDER_UNSPECIFIED,

SORT_ENTRY_ORDER_ASC,

SORT_ENTRY_ORDER_DESC

list_parameters.count

boolean

Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse.

list_parameters.group.aggregation_paths

string

Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps.

list_parameters.group.show_aggregation_uuids

boolean

Return the UUID of each object in each group as specified by aggregation_paths.

list_parameters.group.unique_count_paths

string

List of fields for which we want the unique count. Supports arrays and maps.

list_parameters.group.unique_value_paths

string

List of fields for which we want the unique values. Supports arrays and maps.

list_parameters.ci_run_uuid

string

Only return objects from PR scans that match this context id.

list_parameters.page_id

string

Page ID to retrieve.

list_parameters.group_by_time.aggregation_paths

string

Group the objects based on this time field, for example, meta.create_time.

list_parameters.group_by_time.show_aggregation_uuids

boolean

Return the UUIDs of the objects in each group.

list_parameters.group_by_time.interval

enum<string>

default:GROUP_BY_TIME_INTERVAL_UNSPECIFIED

Interval unit by which the objects should be grouped.

Available options:

GROUP_BY_TIME_INTERVAL_UNSPECIFIED,

GROUP_BY_TIME_INTERVAL_YEAR,

GROUP_BY_TIME_INTERVAL_QUARTER,

GROUP_BY_TIME_INTERVAL_MONTH,

GROUP_BY_TIME_INTERVAL_WEEK,

GROUP_BY_TIME_INTERVAL_DAY,

GROUP_BY_TIME_INTERVAL_HOUR,

GROUP_BY_TIME_INTERVAL_MINUTE,

GROUP_BY_TIME_INTERVAL_SECOND

list_parameters.group_by_time.group_size

integer<int32>

Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2.

list_parameters.group_by_time.start_time

string<date-time>

Beginning of the time period to group objects. Defaults to the beginning of time.

list_parameters.group_by_time.end_time

string<date-time>

End of the time period to group objects. Defaults to the current time.

list_parameters.group_by_time.mode

string

The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time.

list_parameters.group_by_time.aggregation_value_field

string

The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg)

list_parameters.group_by_time.aggregation_operator

string

The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg

list_parameters.disable_pagination

boolean

If true, the results will not be paginated and only the first page will be returned. The order of the results is not guaranteed.

Response

A successful response.

Response to the request to list Semgrep rules.

count_response

object

Response to a list count request.

Show child attributes

group_response

object

Response to a list group request.

Show child attributes

list

object

Show child attributes

Developers & API

Path Parameters

Query Parameters

Response