--- title: "UpdateScanResult" method: PATCH path: "/v1/namespaces/{object.tenant_meta.namespace}/scan-results" tags: ["ScanResultService"] --- # UpdateScanResult `PATCH /v1/namespaces/{object.tenant_meta.namespace}/scan-results` Update a specified scan result. ## Path parameters - `object.tenant_meta.namespace` string, required ## Request body - ScanResultServiceUpdateScanResultBody — Request to update a scan result. - `object` object — Contains the results of an endorctl scan. - `context` V1Context — Contexts keep objects from different scans separated. - `id` string, required — The context ID, such as a pull request ID or branch reference. - `tags` string[] — A list of tags applied to a context. Used primarily for CI and SBOM contexts. - `type` 'CONTEXT_TYPE_UNSPECIFIED' | 'CONTEXT_TYPE_MAIN' | 'CONTEXT_TYPE_EXTERNAL' | 'CONTEXT_TYPE_CI_RUN' | 'CONTEXT_TYPE_SBOM' | 'CONTEXT_TYPE_REF', required — - CONTEXT_TYPE_MAIN: Objects from a scan of the default branch. All objects in the oss namespace are in the main context. The context id is always "default". - CONTEXT_TYPE_EXTERNAL: Indicates that this object is a copy/temporary value of an object in another project. Used for same-tenant dependencies. In source code reference this is equivalent to "vendor" folders. Package versions in the external context are only scanned for call graphs. No other operations are performed on them. - CONTEXT_TYPE_CI_RUN: Objects from a PR scan. The context id is the PR UUID. Objects in this context are deleted after 30 days. - CONTEXT_TYPE_SBOM: Objects from an SBOM scan. The context id is the SBOM serial number or some other unique identifier. - CONTEXT_TYPE_REF: Objects from a scan of a specific branch. The context id is the branch reference name. - `will_be_deleted_at` string, date-time — Time that all objects in this context will be deleted. This field is deprecated and will be removed in the future. Please use the meta.will_be_deleted_at field instead. - `meta` V1Meta — Common fields for all Endor Labs resources. - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string — Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float — search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time — Time that the resource will be deleted. - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required — Resource name. Must be 63 characters or less. - `parent_kind` string — Parent object resource kind, for example, Project. - `parent_uuid` string — Parent object UUID. - `references` object — Map of objects referenced in a query API. - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string — Message version. - `spec` V1ScanResultSpec — ScanResult specific data. - `all_findings` object — Deprecated. - `blocking_findings` string[] — List of blocking finding uuids identified by the scan. - `components_executed` SpecScanComponent[] — Scanner components that actually executed during this scan. - `deleted_findings` object — Map of basic metadata for all findings deleted by the scan, indexed by finding uuid. Not available for CI runs. - `deleted_package_versions` object — List of deleted package versions indexed by UUID. - `ecosystem_dep_counts` object — Number of dependencies per ecosystems processed during the scan. - `ecosystem_pkg_counts` object — Number of package versions per ecosystems processed during the scan. - `end_time` string, date-time — Time the scan ended. - `environment` SpecEnvironment - `arch` string, required - `config` object, required — Configuration used by endorctl. Contains everything except credential values. - `endorctl_version` string, required - `memory` number, double, required - `num_cpus` integer, required - `os` string, required - `tools` EnvironmentTool[] - `name` string, required - `version` string, required - `errors` string[] — Deprecated. - `exception_findings` object — Deprecated. - `exit_code` 'ENDORCTL_RC_UNSPECIFIED' | 'ENDORCTL_RC_SUCCESS' | 'ENDORCTL_RC_ERROR' | 'ENDORCTL_RC_INVALID_ARGS' | 'ENDORCTL_RC_ENDOR_AUTH_FAILURE' | 'ENDORCTL_RC_DOCTOR_FAILURE' | 'ENDORCTL_RC_GITHUB_AUTH_FAILURE' | 'ENDORCTL_RC_ANALYTICS_ERROR' | 'ENDORCTL_RC_FINDINGS_ERROR' | 'ENDORCTL_RC_NOTIFICATIONS_ERROR' | 'ENDORCTL_RC_GITHUB_API_ERROR' | 'ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR' | 'ENDORCTL_RC_GIT_ERROR' | 'ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR' | 'ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR' | 'ENDORCTL_RC_CALL_GRAPH_ERROR' | 'ENDORCTL_RC_LINTER_ERROR' | 'ENDORCTL_RC_BAD_POLICY_TYPE' | 'ENDORCTL_RC_POLICY_ERROR' | 'ENDORCTL_RC_INTERNAL_ERROR' | 'ENDORCTL_RC_DEADLINE_EXCEEDED' | 'ENDORCTL_RC_NOT_FOUND' | 'ENDORCTL_RC_ALREADY_EXISTS' | 'ENDORCTL_RC_UNAUTHENTICATED' | 'ENDORCTL_RC_VULN_ERROR' | 'ENDORCTL_RC_INITIALIZATION_ERROR' | 'ENDORCTL_RC_HOST_CHECK_FAILURE' | 'ENDORCTL_RC_SBOM_IMPORT_ERROR' | 'ENDORCTL_RC_PRE_COMMIT_CHECK_FAILURE' | 'ENDORCTL_RC_GH_ACTION_WORKFLOW_SCAN_FAILURE' | 'ENDORCTL_RC_FILE_ANALYTICS_ERROR' | 'ENDORCTL_RC_SIGNATURE_VERIFICATION_FAILURE' | 'ENDORCTL_RC_LICENSE_ERROR' | 'ENDORCTL_RC_HUGGING_FACE_ERROR' | 'ENDORCTL_RC_SAST_ERROR' | 'ENDORCTL_RC_ARTIFACT_OPERATION_FAILURE' | 'ENDORCTL_RC_SEGMENTATION_ERROR' | 'ENDORCTL_RC_TOOLCHAIN_ERROR' | 'ENDORCTL_RC_SANDBOX_ERROR' | 'ENDORCTL_RC_RULE_SET_ERROR' | 'ENDORCTL_RC_SECURITY_REVIEW_ERROR' | 'ENDORCTL_RC_CODE_API_ERROR' | 'ENDORCTL_RC_BASELINE_NOT_FOUND' | 'ENDORCTL_RC_SCAN_CANCELLED' | 'ENDORCTL_RC_POLICY_VIOLATION' | 'ENDORCTL_RC_POLICY_WARNING' | 'ENDORCTL_RC_PR_SECURITY_REVIEW_ERROR' | 'ENDORCTL_RC_EXPORTER_WARNING' | 'ENDORCTL_RC_CONTAINER_PROFILING_WARNING' | 'ENDORCTL_RC_DEPENDENCY_SETUP_WARNING' — Endorctl return codes. - ENDORCTL_RC_SUCCESS: Success (translates to exit code 0). - ENDORCTL_RC_ERROR: Unspecified error. - ENDORCTL_RC_INVALID_ARGS: Invalid input. - ENDORCTL_RC_ENDOR_AUTH_FAILURE: Endor API authentication failure. - ENDORCTL_RC_DOCTOR_FAILURE: Endor host-check failure. - ENDORCTL_RC_GITHUB_AUTH_FAILURE: GitHub authentication failure. - ENDORCTL_RC_ANALYTICS_ERROR: Error running analytics. - ENDORCTL_RC_FINDINGS_ERROR: Error generating findings. - ENDORCTL_RC_NOTIFICATIONS_ERROR: Error generating notifications. - ENDORCTL_RC_GITHUB_API_ERROR: Error calling GitHub API. - ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR: Insufficient GitHub token permissions. - ENDORCTL_RC_GIT_ERROR: Error while performing a Git operation. - ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR: Error during dependency resolution. - ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR: Error during dependency scanning. - ENDORCTL_RC_CALL_GRAPH_ERROR: Error while generating call graphs. - ENDORCTL_RC_LINTER_ERROR: Error while running the linter scanner. - ENDORCTL_RC_BAD_POLICY_TYPE: A user defined policy has a policy type reserved for system policies. - ENDORCTL_RC_POLICY_ERROR: Error evaluating one or more policies. - ENDORCTL_RC_INTERNAL_ERROR: Internal error while running endorctl. - ENDORCTL_RC_DEADLINE_EXCEEDED: Deadline exceeded while running endorctl. - ENDORCTL_RC_NOT_FOUND: Requested entity was not found. - ENDORCTL_RC_ALREADY_EXISTS: Attempt to create an entity failed because it already exists. - ENDORCTL_RC_UNAUTHENTICATED: Unable to authenticate request. - ENDORCTL_RC_VULN_ERROR: Error related to vulnerability ingestion and processing. - ENDORCTL_RC_INITIALIZATION_ERROR: Error related to initializing the repository. - ENDORCTL_RC_HOST_CHECK_FAILURE: Endor host-check failure. - ENDORCTL_RC_SBOM_IMPORT_ERROR: Error importing an sbom. - ENDORCTL_RC_PRE_COMMIT_CHECK_FAILURE: A pre-commit check failed. - ENDORCTL_RC_GH_ACTION_WORKFLOW_SCAN_FAILURE: GitHub action workflow scan failed. - ENDORCTL_RC_FILE_ANALYTICS_ERROR: Error while reading files for analytics processing. - ENDORCTL_RC_SIGNATURE_VERIFICATION_FAILURE: Signature verification failure. - ENDORCTL_RC_LICENSE_ERROR: The requested operation requires additional licensing. - ENDORCTL_RC_HUGGING_FACE_ERROR: Error while running the huggingface scanner. - ENDORCTL_RC_SAST_ERROR: Error while running the SAST scanner. - ENDORCTL_RC_ARTIFACT_OPERATION_FAILURE: Artifact operation failure. - ENDORCTL_RC_SEGMENTATION_ERROR: Error during file segmentation. - ENDORCTL_RC_TOOLCHAIN_ERROR: Error generating toolchains. - ENDORCTL_RC_SANDBOX_ERROR: Error running endorctl sandbox. - ENDORCTL_RC_RULE_SET_ERROR: Error performing rule set operations. - ENDORCTL_RC_SECURITY_REVIEW_ERROR: Error while running the PR security review. - ENDORCTL_RC_CODE_API_ERROR: Error while running codeAPI. - ENDORCTL_RC_BASELINE_NOT_FOUND: Baseline is invalid or has not been scanned yet. - ENDORCTL_RC_SCAN_CANCELLED: Scan was cancelled. - ENDORCTL_RC_POLICY_VIOLATION: One or more, enforced, admission policy violations detected. - ENDORCTL_RC_POLICY_WARNING: One ore more, unenforced, admission policy violations detected. - ENDORCTL_RC_PR_SECURITY_REVIEW_ERROR: Deprecated: Use ENDORCTL_RC_SECURITY_REVIEW_ERROR instead. - ENDORCTL_RC_EXPORTER_WARNING: Warning while running the exporter. This does not prevent the main scan from completing. - ENDORCTL_RC_CONTAINER_PROFILING_WARNING: Warning while profiling a container image. - ENDORCTL_RC_DEPENDENCY_SETUP_WARNING: Warning during dependency environment setup (e.g. truststore creation). The scan continues with a fallback configuration but may encounter issues. - `findings` string[] — List of all finding UUIDs identified by the scan. - `has_panic` boolean — True if there was a panic during the scan. - `infos` string[] — Deprecated. - `languages_detected` string[] — List of languages detected by the scan. - `logs` string[] — User facing log output for the scan. - `policies_triggered` string[] — List of policy uuids triggered during the scan. - `provisioning_result` SpecProvisioningResultData - `auto_detect_result` V1AutoDetectResult — Message for an auto detect result. - `detected_tool_chain_versions` object - `detected_versions` object — Detected versions by lanaguage. - `error` string — Auto detect error message. - `tool_chains` V1ToolChains - `android_tool_chain` V1AndroidToolChain - … - `dotnet_tool_chain` V1DotNetToolChain - … - `environment_variables` string[] — environment_variables are the env variables to be set during toolchain installation. - `golang_tool_chain` V1GolangToolChain - … - `java_tool_chain` V1JavaToolChain - … - `javascript_tool_chain` V1JavaScriptToolChain - … - `php_tool_chain` V1PHPToolChain - … - `python_tool_chain` V1PythonToolChain - … - `ruby_tool_chain` V1RubyToolChain - … - `rust_tool_chain` V1RustToolChain - … - `scala_tool_chain` V1ScalaToolChain - … - `swift_tool_chain` V1SwiftToolChain - … - `automated_scan_parameters_config` V1AutomatedScanParametersConfig — Message for automated scan parameter configuration. - `automated_scan_parameters_source` 'AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_API' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_FILE' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_NAMESPACE_DEFAULT' — Automated scan parameter source types. - `resolved_scan_environment_variables` string[] — Resolved environment variables. - `error` string — Provisioning error message. - `exit_code` integer — Provisioning exit code. - `provisioning_result_uuid` string, required — UUID of the provisioning result. - `scan_profile` V1ScanProfile — ScanProfile represents the scan configuration to use across different projects. - `meta` V1Meta, required — Common fields for all Endor Labs resources. - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string — Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object. - … - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required — Resource name. Must be 63 characters or less. - `parent_kind` string — Parent object resource kind, for example, Project. - `parent_uuid` string — Parent object UUID. - `references` object — Map of objects referenced in a query API. - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string — Message version. - `propagate` boolean — Indicates that the object should be visible in the child namespaces. - `spec` V1ScanProfileSpec, required — Spec is the internal specification of the object. - `ai_sast_analysis_parameters` V1AISastAnalysisParameters — Runtime parameters controlling behavior of ai sast analysis. - … - `automated_scan_parameters` V1AutomatedScanParameters — AutomatedScanParameters represents the parameters that must be applied during automated cloud scans to the projects associated with the corresponding profile. - … - `exporter_parameters` SpecExporterParameters - … - `is_default` boolean — is_default indicates that the scan profile is the namespace default. - `remediation_parameters` V1RemediationParameters — RemediationParameters holds the settings for remediation actions. - … - `security_review_scanner_parameters` SpecSecurityReviewScannerParameters - … - `toolchain_profile` V1ToolChainProfile — ToolChainProfile represents the list of tool chains that need to be installed. - … - `tenant_meta` V1TenantMeta, required — Tenant related data for the tenant containing the resource. - `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 — UUID is a universally unique identifier for the tool chain profile. - `tool_chains` V1ToolChains - `android_tool_chain` V1AndroidToolChain - `command_line_tools_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `packages` string[] - `dotnet_tool_chain` V1DotNetToolChain - `additional_dotnet_versions` string[] - `dotnet_installer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `environment_variables` string[] — environment_variables are the env variables to be set during toolchain installation. - `golang_tool_chain` V1GolangToolChain - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `java_tool_chain` V1JavaToolChain - `gradle_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `maven_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `javascript_tool_chain` V1JavaScriptToolChain - `nodejs_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `npm_packages` object - `pnpm_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rush_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `yarn_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `php_tool_chain` V1PHPToolChain - `composer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `python_tool_chain` V1PythonToolChain - `pip_packages` object — the key is the package name to install through pip. - `poetry_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `ruby_tool_chain` V1RubyToolChain - `dependabot_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `ruby_gems` object - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rust_tool_chain` V1RustToolChain - `mirai_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rustup_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `scala_tool_chain` V1ScalaToolChain - `java_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `swift_tool_chain` V1SwiftToolChain - `additional_swift_versions` string[] - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `tool_chains_source` 'TOOL_CHAINS_SOURCE_UNSPECIFIED' | 'TOOL_CHAINS_SOURCE_API' | 'TOOL_CHAINS_SOURCE_FILE' | 'TOOL_CHAINS_SOURCE_AUTO_DETECTION' | 'TOOL_CHAINS_SOURCE_DEFAULTS' | 'TOOL_CHAINS_SOURCE_NAMESPACE_DEFAULT' — Toolchain source types. - `provisioning_result_uuid` string - `refs` string[] — List of branches scanned. - `runtimes` object — A map of internal scan type runtimes (in milliseconds) indexed by internal scan type string. - `start_time` string, date-time — Time the scan started. - `stats` object — Map of stats such as how many issues were ingested during the scan. - `status` 'STATUS_UNSPECIFIED' | 'STATUS_SUCCESS' | 'STATUS_PARTIAL_SUCCESS' | 'STATUS_FAILURE' | 'STATUS_RUNNING', required — Success state. - `type` 'TYPE_UNSPECIFIED' | 'TYPE_GITHUB' | 'TYPE_GIT' | 'TYPE_ORG' | 'TYPE_PACKAGE' | 'TYPE_ANALYTICS' | 'TYPE_FINDINGS' | 'TYPE_SBOM_IMPORT' | 'TYPE_LINTER' | 'TYPE_ADMISSION_POLICIES' | 'TYPE_DOCTOR' | 'TYPE_NOTIFICATION_POLICIES' | 'TYPE_ALERT_POLICIES' | 'TYPE_ALL_SCANS' | 'TYPE_HOST_CHECK' | 'TYPE_DEPENDENCY_RESOLUTION' | 'TYPE_CALL_GRAPH' | 'TYPE_EXCEPTION_POLICIES' | 'TYPE_FILE_ANALYTICS' | 'TYPE_HUGGING_FACE' | 'TYPE_PROVISIONING' | 'TYPE_WORKFLOW_SCAN' | 'TYPE_PR_SECURITY_REVIEW' | 'TYPE_UIA' | 'TYPE_ANALYTICS_CHECK' | 'TYPE_LICENSE_DISCOVERY' | 'TYPE_FINDING_REFRESH', required — Scan type. Only used for runtime statistics. - TYPE_DOCTOR: Deprecated. - TYPE_ALERT_POLICIES: Deprecated. - TYPE_FINDING_REFRESH: Lightweight re-evaluation of findings from persisted DependencyMetadata, without a full repository re-scan. - `versions` V1Version[] — Version information for each ref. - `metadata` object — Version metadata. - `ref` string, required — Resolved ref of the source control version. Can be a tag, a branch or a SHA. - `sha` string — SHA of the source control version. Because the SHA might not be possible to resolved this field is optional. - `warning_findings` string[] — List of warning finding uuids identified by the scan. - `warnings` string[] — Deprecated. - `tenant_meta` object — Information about the tenant and namespace that the scan ran in. - `uuid` string — The UUID of the object. - `request` V1UpdateRequest — Message used for all update requests. - `force` boolean — Force will force the update of the resource if any checks fail. - `update_mask` string — Fields to update. Defaults to all fields. ## Response `200` A successful response. - V1ScanResult — Contains the results of an endorctl scan. - `context` V1Context, required — Contexts keep objects from different scans separated. - `id` string, required — The context ID, such as a pull request ID or branch reference. - `tags` string[] — A list of tags applied to a context. Used primarily for CI and SBOM contexts. - `type` 'CONTEXT_TYPE_UNSPECIFIED' | 'CONTEXT_TYPE_MAIN' | 'CONTEXT_TYPE_EXTERNAL' | 'CONTEXT_TYPE_CI_RUN' | 'CONTEXT_TYPE_SBOM' | 'CONTEXT_TYPE_REF', required — - CONTEXT_TYPE_MAIN: Objects from a scan of the default branch. All objects in the oss namespace are in the main context. The context id is always "default". - CONTEXT_TYPE_EXTERNAL: Indicates that this object is a copy/temporary value of an object in another project. Used for same-tenant dependencies. In source code reference this is equivalent to "vendor" folders. Package versions in the external context are only scanned for call graphs. No other operations are performed on them. - CONTEXT_TYPE_CI_RUN: Objects from a PR scan. The context id is the PR UUID. Objects in this context are deleted after 30 days. - CONTEXT_TYPE_SBOM: Objects from an SBOM scan. The context id is the SBOM serial number or some other unique identifier. - CONTEXT_TYPE_REF: Objects from a scan of a specific branch. The context id is the branch reference name. - `will_be_deleted_at` string, date-time — Time that all objects in this context will be deleted. This field is deprecated and will be removed in the future. Please use the meta.will_be_deleted_at field instead. - `meta` V1Meta, required — Common fields for all Endor Labs resources. - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string — Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float — search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time — Time that the resource will be deleted. - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required — Resource name. Must be 63 characters or less. - `parent_kind` string — Parent object resource kind, for example, Project. - `parent_uuid` string — Parent object UUID. - `references` object — Map of objects referenced in a query API. - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string — Message version. - `spec` V1ScanResultSpec — ScanResult specific data. - `all_findings` object — Deprecated. - `blocking_findings` string[] — List of blocking finding uuids identified by the scan. - `components_executed` SpecScanComponent[] — Scanner components that actually executed during this scan. - `deleted_findings` object — Map of basic metadata for all findings deleted by the scan, indexed by finding uuid. Not available for CI runs. - `deleted_package_versions` object — List of deleted package versions indexed by UUID. - `ecosystem_dep_counts` object — Number of dependencies per ecosystems processed during the scan. - `ecosystem_pkg_counts` object — Number of package versions per ecosystems processed during the scan. - `end_time` string, date-time — Time the scan ended. - `environment` SpecEnvironment - `arch` string, required - `config` object, required — Configuration used by endorctl. Contains everything except credential values. - `endorctl_version` string, required - `memory` number, double, required - `num_cpus` integer, required - `os` string, required - `tools` EnvironmentTool[] - `name` string, required - `version` string, required - `errors` string[] — Deprecated. - `exception_findings` object — Deprecated. - `exit_code` 'ENDORCTL_RC_UNSPECIFIED' | 'ENDORCTL_RC_SUCCESS' | 'ENDORCTL_RC_ERROR' | 'ENDORCTL_RC_INVALID_ARGS' | 'ENDORCTL_RC_ENDOR_AUTH_FAILURE' | 'ENDORCTL_RC_DOCTOR_FAILURE' | 'ENDORCTL_RC_GITHUB_AUTH_FAILURE' | 'ENDORCTL_RC_ANALYTICS_ERROR' | 'ENDORCTL_RC_FINDINGS_ERROR' | 'ENDORCTL_RC_NOTIFICATIONS_ERROR' | 'ENDORCTL_RC_GITHUB_API_ERROR' | 'ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR' | 'ENDORCTL_RC_GIT_ERROR' | 'ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR' | 'ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR' | 'ENDORCTL_RC_CALL_GRAPH_ERROR' | 'ENDORCTL_RC_LINTER_ERROR' | 'ENDORCTL_RC_BAD_POLICY_TYPE' | 'ENDORCTL_RC_POLICY_ERROR' | 'ENDORCTL_RC_INTERNAL_ERROR' | 'ENDORCTL_RC_DEADLINE_EXCEEDED' | 'ENDORCTL_RC_NOT_FOUND' | 'ENDORCTL_RC_ALREADY_EXISTS' | 'ENDORCTL_RC_UNAUTHENTICATED' | 'ENDORCTL_RC_VULN_ERROR' | 'ENDORCTL_RC_INITIALIZATION_ERROR' | 'ENDORCTL_RC_HOST_CHECK_FAILURE' | 'ENDORCTL_RC_SBOM_IMPORT_ERROR' | 'ENDORCTL_RC_PRE_COMMIT_CHECK_FAILURE' | 'ENDORCTL_RC_GH_ACTION_WORKFLOW_SCAN_FAILURE' | 'ENDORCTL_RC_FILE_ANALYTICS_ERROR' | 'ENDORCTL_RC_SIGNATURE_VERIFICATION_FAILURE' | 'ENDORCTL_RC_LICENSE_ERROR' | 'ENDORCTL_RC_HUGGING_FACE_ERROR' | 'ENDORCTL_RC_SAST_ERROR' | 'ENDORCTL_RC_ARTIFACT_OPERATION_FAILURE' | 'ENDORCTL_RC_SEGMENTATION_ERROR' | 'ENDORCTL_RC_TOOLCHAIN_ERROR' | 'ENDORCTL_RC_SANDBOX_ERROR' | 'ENDORCTL_RC_RULE_SET_ERROR' | 'ENDORCTL_RC_SECURITY_REVIEW_ERROR' | 'ENDORCTL_RC_CODE_API_ERROR' | 'ENDORCTL_RC_BASELINE_NOT_FOUND' | 'ENDORCTL_RC_SCAN_CANCELLED' | 'ENDORCTL_RC_POLICY_VIOLATION' | 'ENDORCTL_RC_POLICY_WARNING' | 'ENDORCTL_RC_PR_SECURITY_REVIEW_ERROR' | 'ENDORCTL_RC_EXPORTER_WARNING' | 'ENDORCTL_RC_CONTAINER_PROFILING_WARNING' | 'ENDORCTL_RC_DEPENDENCY_SETUP_WARNING' — Endorctl return codes. - ENDORCTL_RC_SUCCESS: Success (translates to exit code 0). - ENDORCTL_RC_ERROR: Unspecified error. - ENDORCTL_RC_INVALID_ARGS: Invalid input. - ENDORCTL_RC_ENDOR_AUTH_FAILURE: Endor API authentication failure. - ENDORCTL_RC_DOCTOR_FAILURE: Endor host-check failure. - ENDORCTL_RC_GITHUB_AUTH_FAILURE: GitHub authentication failure. - ENDORCTL_RC_ANALYTICS_ERROR: Error running analytics. - ENDORCTL_RC_FINDINGS_ERROR: Error generating findings. - ENDORCTL_RC_NOTIFICATIONS_ERROR: Error generating notifications. - ENDORCTL_RC_GITHUB_API_ERROR: Error calling GitHub API. - ENDORCTL_RC_GITHUB_PERMISSIONS_ERROR: Insufficient GitHub token permissions. - ENDORCTL_RC_GIT_ERROR: Error while performing a Git operation. - ENDORCTL_RC_DEPENDENCY_RESOLUTION_ERROR: Error during dependency resolution. - ENDORCTL_RC_DEPENDENCY_SCANNING_ERROR: Error during dependency scanning. - ENDORCTL_RC_CALL_GRAPH_ERROR: Error while generating call graphs. - ENDORCTL_RC_LINTER_ERROR: Error while running the linter scanner. - ENDORCTL_RC_BAD_POLICY_TYPE: A user defined policy has a policy type reserved for system policies. - ENDORCTL_RC_POLICY_ERROR: Error evaluating one or more policies. - ENDORCTL_RC_INTERNAL_ERROR: Internal error while running endorctl. - ENDORCTL_RC_DEADLINE_EXCEEDED: Deadline exceeded while running endorctl. - ENDORCTL_RC_NOT_FOUND: Requested entity was not found. - ENDORCTL_RC_ALREADY_EXISTS: Attempt to create an entity failed because it already exists. - ENDORCTL_RC_UNAUTHENTICATED: Unable to authenticate request. - ENDORCTL_RC_VULN_ERROR: Error related to vulnerability ingestion and processing. - ENDORCTL_RC_INITIALIZATION_ERROR: Error related to initializing the repository. - ENDORCTL_RC_HOST_CHECK_FAILURE: Endor host-check failure. - ENDORCTL_RC_SBOM_IMPORT_ERROR: Error importing an sbom. - ENDORCTL_RC_PRE_COMMIT_CHECK_FAILURE: A pre-commit check failed. - ENDORCTL_RC_GH_ACTION_WORKFLOW_SCAN_FAILURE: GitHub action workflow scan failed. - ENDORCTL_RC_FILE_ANALYTICS_ERROR: Error while reading files for analytics processing. - ENDORCTL_RC_SIGNATURE_VERIFICATION_FAILURE: Signature verification failure. - ENDORCTL_RC_LICENSE_ERROR: The requested operation requires additional licensing. - ENDORCTL_RC_HUGGING_FACE_ERROR: Error while running the huggingface scanner. - ENDORCTL_RC_SAST_ERROR: Error while running the SAST scanner. - ENDORCTL_RC_ARTIFACT_OPERATION_FAILURE: Artifact operation failure. - ENDORCTL_RC_SEGMENTATION_ERROR: Error during file segmentation. - ENDORCTL_RC_TOOLCHAIN_ERROR: Error generating toolchains. - ENDORCTL_RC_SANDBOX_ERROR: Error running endorctl sandbox. - ENDORCTL_RC_RULE_SET_ERROR: Error performing rule set operations. - ENDORCTL_RC_SECURITY_REVIEW_ERROR: Error while running the PR security review. - ENDORCTL_RC_CODE_API_ERROR: Error while running codeAPI. - ENDORCTL_RC_BASELINE_NOT_FOUND: Baseline is invalid or has not been scanned yet. - ENDORCTL_RC_SCAN_CANCELLED: Scan was cancelled. - ENDORCTL_RC_POLICY_VIOLATION: One or more, enforced, admission policy violations detected. - ENDORCTL_RC_POLICY_WARNING: One ore more, unenforced, admission policy violations detected. - ENDORCTL_RC_PR_SECURITY_REVIEW_ERROR: Deprecated: Use ENDORCTL_RC_SECURITY_REVIEW_ERROR instead. - ENDORCTL_RC_EXPORTER_WARNING: Warning while running the exporter. This does not prevent the main scan from completing. - ENDORCTL_RC_CONTAINER_PROFILING_WARNING: Warning while profiling a container image. - ENDORCTL_RC_DEPENDENCY_SETUP_WARNING: Warning during dependency environment setup (e.g. truststore creation). The scan continues with a fallback configuration but may encounter issues. - `findings` string[] — List of all finding UUIDs identified by the scan. - `has_panic` boolean — True if there was a panic during the scan. - `infos` string[] — Deprecated. - `languages_detected` string[] — List of languages detected by the scan. - `logs` string[] — User facing log output for the scan. - `policies_triggered` string[] — List of policy uuids triggered during the scan. - `provisioning_result` SpecProvisioningResultData - `auto_detect_result` V1AutoDetectResult — Message for an auto detect result. - `detected_tool_chain_versions` object - `detected_versions` object — Detected versions by lanaguage. - `error` string — Auto detect error message. - `tool_chains` V1ToolChains - `android_tool_chain` V1AndroidToolChain - `command_line_tools_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `packages` string[] - `dotnet_tool_chain` V1DotNetToolChain - `additional_dotnet_versions` string[] - `dotnet_installer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `environment_variables` string[] — environment_variables are the env variables to be set during toolchain installation. - `golang_tool_chain` V1GolangToolChain - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `java_tool_chain` V1JavaToolChain - `gradle_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `maven_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `javascript_tool_chain` V1JavaScriptToolChain - `nodejs_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `npm_packages` object - `pnpm_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rush_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `yarn_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `php_tool_chain` V1PHPToolChain - `composer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `python_tool_chain` V1PythonToolChain - `pip_packages` object — the key is the package name to install through pip. - `poetry_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `ruby_tool_chain` V1RubyToolChain - `dependabot_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `ruby_gems` object - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rust_tool_chain` V1RustToolChain - `mirai_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `rustup_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `scala_tool_chain` V1ScalaToolChain - `java_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `swift_tool_chain` V1SwiftToolChain - `additional_swift_versions` string[] - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - … - `automated_scan_parameters_config` V1AutomatedScanParametersConfig — Message for automated scan parameter configuration. - `automated_scan_parameters_source` 'AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_API' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_FILE' | 'AUTOMATED_SCAN_PARAMETERS_SOURCE_NAMESPACE_DEFAULT' — Automated scan parameter source types. - `resolved_scan_environment_variables` string[] — Resolved environment variables. - `error` string — Provisioning error message. - `exit_code` integer — Provisioning exit code. - `provisioning_result_uuid` string, required — UUID of the provisioning result. - `scan_profile` V1ScanProfile — ScanProfile represents the scan configuration to use across different projects. - `meta` V1Meta, required — Common fields for all Endor Labs resources. - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string — Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float — search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time — Time that the resource will be deleted. - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required — Resource name. Must be 63 characters or less. - `parent_kind` string — Parent object resource kind, for example, Project. - `parent_uuid` string — Parent object UUID. - `references` object — Map of objects referenced in a query API. - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string — Message version. - `propagate` boolean — Indicates that the object should be visible in the child namespaces. - `spec` V1ScanProfileSpec, required — Spec is the internal specification of the object. - `ai_sast_analysis_parameters` V1AISastAnalysisParameters — Runtime parameters controlling behavior of ai sast analysis. - `fp_triage` boolean — enable false positive triage of sast findings using AI. - `mode` 'AI_SAST_ANALYSIS_MODE_UNSPECIFIED' | 'AI_SAST_ANALYSIS_MODE_AGENT' | 'AI_SAST_ANALYSIS_MODE_AGENT_DEEP' | 'AI_SAST_ANALYSIS_MODE_AGENT_FALLBACK' — - AI_SAST_ANALYSIS_MODE_UNSPECIFIED: Options available for peforming AI triage of Sast Findings. - AI_SAST_ANALYSIS_MODE_AGENT_FALLBACK: AI_SAST_ANALYSIS_AGENT_ZEROSHOT_CODE_API = 4; // TODO add when ready. - `retriage` boolean — enable retriage of sast findings using AI. - `automated_scan_parameters` V1AutomatedScanParameters — AutomatedScanParameters represents the parameters that must be applied during automated cloud scans to the projects associated with the corresponding profile. - `additional_environment_variables` string[] — additional_environment_variables is a list of additional environment variables that must be used, specific to languages or tools. - `bazel_configuration` AutomatedScanParametersBazelConfiguration - … - `call_graph_languages` string[] — call_graph_languages is the list of languages that should be used to calculate call graphs. If empty, default values are used. - `disable_code_snippet_storage` boolean — disable_code_snippet_storage is a boolean value that indicates if the source code snippet related to a finding should be stored or displayed. Default will be off. - `disable_code_storage` boolean — disable_code_storage is a boolean value that indicates if the source code related to a finding should be stored or displayed. Default will be off. - `enable_ai_sast_scan` boolean — enable_ai_sast_scan is a boolean value that indicates if AI SAST scan should be requested. - `enable_automated_pr_scans` boolean — enable_automated_pr_scans for this repository will allow the github app to selectively scan PRs and merges for this repository. If the project is not part of a github app, this setting will be ingored. - `enable_full_git_log_secret_scan` boolean — enable_full_git_log_secret_scan for this repository. - `enable_pr_comments` boolean — enable_pr_comments for this repository. - `enable_pr_incremental_scan` boolean — enable_pr_incremental_scan is a boolean value that indicates if the PR incremental scan should be requested. - `enable_pr_security_review_scan` boolean — enable_pr_security_review_scan is a boolean value that indicates if a Security Review scan should be requested. - `enable_remediation_action` boolean — enable_remediation_action for this repository. - `enable_sast_scan` boolean — enable_sast_scan for this repository. - `enable_secret_scan` boolean — enable_secret_scan for this repository. - `excluded_paths` string[] — excluded_paths is a list of paths that should be excluded from the scan. - `full_pr_scan` boolean — full_pr_scan indicates whether a full scan should be enabled during PRs. - `full_push_scan` boolean — full_push_scan indicates whether a full scan should be enabled during pushes. - `included_paths` string[] — included_paths is a list of paths that should be included in the scan. - `languages` string[] — languages is a list of languages that should be scanned. If emtpy default values are used. - `segment_match_languages` string[] — segment_match_languages is the list of languages to enable segment-match based analysis for. Clears the default languages if languages is not set explicitly. - `exporter_parameters` SpecExporterParameters - `exporter_uuids` string[] — exporter_uuids is the list of exporter objects that will be used for exports at the end of the scan. - `is_default` boolean — is_default indicates that the scan profile is the namespace default. - `remediation_parameters` V1RemediationParameters — RemediationParameters holds the settings for remediation actions. - `automated_pr_parameters` RemediationParametersAutomatedPRParameters — AutomatedPRParameters holds the settings for automated PRs. - … - `security_review_scanner_parameters` SpecSecurityReviewScannerParameters - `disable_code_summary` boolean — disable_code_summary indicates that the code summary part of the security review should be disabled whether or not there are findings. - `user_prompt` string — user_prompt is the user prompt for the security review scanner. it is used to customize the security review scanner and give the ability to the user to provide their own prompt to customize the security review and the findings that are reported. This is optional. - `toolchain_profile` V1ToolChainProfile — ToolChainProfile represents the list of tool chains that need to be installed. - `os` object - `tenant_meta` V1TenantMeta, required — Tenant related data for the tenant containing the resource. - `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 — UUID is a universally unique identifier for the tool chain profile. - `tool_chains` V1ToolChains - `android_tool_chain` V1AndroidToolChain - `command_line_tools_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `packages` string[] - `dotnet_tool_chain` V1DotNetToolChain - `additional_dotnet_versions` string[] - `dotnet_installer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `environment_variables` string[] — environment_variables are the env variables to be set during toolchain installation. - `golang_tool_chain` V1GolangToolChain - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `java_tool_chain` V1JavaToolChain - `gradle_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `maven_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `javascript_tool_chain` V1JavaScriptToolChain - `nodejs_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `npm_packages` object - `pnpm_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `rush_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `yarn_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `php_tool_chain` V1PHPToolChain - `composer_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `python_tool_chain` V1PythonToolChain - `pip_packages` object — the key is the package name to install through pip. - `poetry_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `ruby_tool_chain` V1RubyToolChain - `dependabot_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `ruby_gems` object - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `rust_tool_chain` V1RustToolChain - `mirai_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `rustup_version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `scala_tool_chain` V1ScalaToolChain - `java_version` V1ToolChainVersion — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `swift_tool_chain` V1SwiftToolChain - `additional_swift_versions` string[] - `version` V1ToolChainVersion, required — ToolChainVersion defines the tool chain's source from where it can be installed. - `name` string — name of the tool chain. - `relative_tool_chain_path` string — relative path of the tool chain in tar ball. - `sha256_sum` string — SHA256 Digest of the tool that will be downloaded. - `urls` string[] — http mirros from where the tool can be downloaded. - `tool_chains_source` 'TOOL_CHAINS_SOURCE_UNSPECIFIED' | 'TOOL_CHAINS_SOURCE_API' | 'TOOL_CHAINS_SOURCE_FILE' | 'TOOL_CHAINS_SOURCE_AUTO_DETECTION' | 'TOOL_CHAINS_SOURCE_DEFAULTS' | 'TOOL_CHAINS_SOURCE_NAMESPACE_DEFAULT' — Toolchain source types. - `provisioning_result_uuid` string - `refs` string[] — List of branches scanned. - `runtimes` object — A map of internal scan type runtimes (in milliseconds) indexed by internal scan type string. - `start_time` string, date-time — Time the scan started. - `stats` object — Map of stats such as how many issues were ingested during the scan. - `status` 'STATUS_UNSPECIFIED' | 'STATUS_SUCCESS' | 'STATUS_PARTIAL_SUCCESS' | 'STATUS_FAILURE' | 'STATUS_RUNNING', required — Success state. - `type` 'TYPE_UNSPECIFIED' | 'TYPE_GITHUB' | 'TYPE_GIT' | 'TYPE_ORG' | 'TYPE_PACKAGE' | 'TYPE_ANALYTICS' | 'TYPE_FINDINGS' | 'TYPE_SBOM_IMPORT' | 'TYPE_LINTER' | 'TYPE_ADMISSION_POLICIES' | 'TYPE_DOCTOR' | 'TYPE_NOTIFICATION_POLICIES' | 'TYPE_ALERT_POLICIES' | 'TYPE_ALL_SCANS' | 'TYPE_HOST_CHECK' | 'TYPE_DEPENDENCY_RESOLUTION' | 'TYPE_CALL_GRAPH' | 'TYPE_EXCEPTION_POLICIES' | 'TYPE_FILE_ANALYTICS' | 'TYPE_HUGGING_FACE' | 'TYPE_PROVISIONING' | 'TYPE_WORKFLOW_SCAN' | 'TYPE_PR_SECURITY_REVIEW' | 'TYPE_UIA' | 'TYPE_ANALYTICS_CHECK' | 'TYPE_LICENSE_DISCOVERY' | 'TYPE_FINDING_REFRESH', required — Scan type. Only used for runtime statistics. - TYPE_DOCTOR: Deprecated. - TYPE_ALERT_POLICIES: Deprecated. - TYPE_FINDING_REFRESH: Lightweight re-evaluation of findings from persisted DependencyMetadata, without a full repository re-scan. - `versions` V1Version[] — Version information for each ref. - `metadata` object — Version metadata. - `ref` string, required — Resolved ref of the source control version. Can be a tag, a branch or a SHA. - `sha` string — SHA of the source control version. Because the SHA might not be possible to resolved this field is optional. - `warning_findings` string[] — List of warning finding uuids identified by the scan. - `warnings` string[] — Deprecated. - `tenant_meta` V1TenantMeta — Tenant related data for the tenant containing the resource. - `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 — The UUID of the object. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/versions/2fe1f84213b3/schema)