Skip to main content
GET
/
v1
/
namespaces
/
{tenant_meta.namespace}
/
semgrep-rules
/
{uuid}
GetSemgrepRule
curl --request GET \
  --url https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/semgrep-rules/{uuid}
{
  "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>"
}

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".

​
uuid
string
required

The UUID of the requested resource.

Query Parameters

​
get_parameters.mask
string

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

Response

A successful response.

​
meta
object
required

Common fields for all Endor Labs resources.

​
spec
object
required
​
disabled
boolean
​
propagate
boolean

Propagate indicates that the object should be visible in child namespaces.

​
tenant_meta
object

Tenant related data for the tenant containing the resource.

​
uuid
string

The UUID of the Semgrep rule.