--- title: "UpdateVersionUpgrade" method: PATCH path: "/v1/namespaces/{object.tenant_meta.namespace}/version-upgrades" tags: ["VersionUpgradeService"] --- # UpdateVersionUpgrade `PATCH /v1/namespaces/{object.tenant_meta.namespace}/version-upgrades` Updates a version upgrade. ## Path parameters - `object.tenant_meta.namespace` string, required ## Request body - VersionUpgradeServiceUpdateVersionUpgradeBody — Request to update a version upgrade. - `object` object — VersionUpgrade contains all information about a possible version upgrade of a dependency package. This upgrade object can be under a project or a package version object. - `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` V1VersionUpgradeSpec - `all_upgrades` VersionUpgradeUpgradeList - `upgrade_list` V1ReleaseUpgradeInfo[] - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - … - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - … - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `configuration` V1ReleaseUpgradeConfiguration - `avoid_pre_releases` boolean — Avoid prereleases. - `no_upgrade_package_set` string[] — These packages can not be upgraded and will be skipped. - `prefer_minor_version_upgrades` boolean — Give higher priority to upgrades to versions with the same major version since these are more likely to be compatible. - `reachable_findings_only` boolean — Only consider reachable findings. - `score_improvement_threshold` integer — Score improvement to consider an upgrade. - `skip_test` boolean — If true, ignores all the direct dependencies that are marked as TEST/BUILD. - `target_dependency` string — Only analyze this direct dependency and ignore the others. - `top_only` integer — Only show the top N dependency upgrades. - `upgrade_if_better_scores` boolean — Whether to consider a version upgrade just to improve the Endor scores or not. - `upgrade_if_operational_findings` string — Whether to consider a version upgrade if the current version has only operational findings or not. - `upgrade_if_vulnerability_findings` string — Whether to consider a version upgrade if the current version has vulnerability findings or not. - `use_cia` boolean — Whether using change impact analysis or not. - `finding_fixing_upgrades` object — Upgrades that fix findings. - `name` string, required — The name of the project or package version for this record. - `prioritized_upgrades` VersionUpgradeUpgradeList - `upgrade_list` V1ReleaseUpgradeInfo[] - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - … - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - … - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `project_uuid` string, required — The UUID of the project to which this version upgrade relates. - `stats` V1ReleaseUpgradeStats - `cia_invocations` integer — CIA Invocations. - `compute_time` number, float — Compute time. - `data_load_time` number, float — Data load time. - `database_version_count` integer — The number of versions for direct dependencies we found in our database. - `dep_meta_count` integer — Dependency meta Count. - `dep_uuids` integer — Dependency UUIDs. - `direct_dependency_count` integer — Direct dependency count. - `direct_deps_count` integer — Direct cependencies count. - `direct_deps_package_count` integer — Direct dependencies package count. - `findings_after_filtering` integer — Findings after filtering. - `findings_fixed_by_upgrade_count` integer — Findings Fixed By Upgrade Count. - `findings_read` integer — Findings read. - `incomplete_releases` integer — Releases not considered because of lack of information. - `max_releases_behind` integer — Max Releases Behind. - `missing_version_count` integer — The number of direct dependency versions we miss from our database. - `namespace` string — Namespace. - `package_count` integer — Package Count. - `package_manager_version_count` integer — The number of versions for direct dependencies that we found in the package manager. - `pre_upgrade_findings_count` integer — Pre-upgrade Findings Count. - `project_name` string — Project Name. - `project_uuid` string — Project UUID. - `score_breakdown` object — Score breakdown. - `scores_read` integer — Scores read. - `skipped_due_to_cia` integer — Skipped due To CIA. - `upgrades_proposed` integer — Upgrades proposed. - `upgrades_reviewed` integer — Upgrades reviewed. - `upgrades_skipped` integer — Upgrades skipped. - `zero_conflict_upgrades_proposed` integer — Zero conflict upgrades proposed. - `upgrade_info` V1ReleaseUpgradeInfo — Protobuf definition for ReleaseUpgradeInfo. - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - `defined` boolean - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `function_reference` string - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - `declared_type` string - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `package_name` string - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `tenant_meta` object — Tenant metadata information. - `uuid` string — The UUID of the resource. - `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. - V1VersionUpgrade — VersionUpgrade contains all information about a possible version upgrade of a dependency package. This upgrade object can be under a project or a package version object. - `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` V1VersionUpgradeSpec - `all_upgrades` VersionUpgradeUpgradeList - `upgrade_list` V1ReleaseUpgradeInfo[] - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - `defined` boolean - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `function_reference` string - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - `declared_type` string - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `package_name` string - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `configuration` V1ReleaseUpgradeConfiguration - `avoid_pre_releases` boolean — Avoid prereleases. - `no_upgrade_package_set` string[] — These packages can not be upgraded and will be skipped. - `prefer_minor_version_upgrades` boolean — Give higher priority to upgrades to versions with the same major version since these are more likely to be compatible. - `reachable_findings_only` boolean — Only consider reachable findings. - `score_improvement_threshold` integer — Score improvement to consider an upgrade. - `skip_test` boolean — If true, ignores all the direct dependencies that are marked as TEST/BUILD. - `target_dependency` string — Only analyze this direct dependency and ignore the others. - `top_only` integer — Only show the top N dependency upgrades. - `upgrade_if_better_scores` boolean — Whether to consider a version upgrade just to improve the Endor scores or not. - `upgrade_if_operational_findings` string — Whether to consider a version upgrade if the current version has only operational findings or not. - `upgrade_if_vulnerability_findings` string — Whether to consider a version upgrade if the current version has vulnerability findings or not. - `use_cia` boolean — Whether using change impact analysis or not. - `finding_fixing_upgrades` object — Upgrades that fix findings. - `name` string, required — The name of the project or package version for this record. - `prioritized_upgrades` VersionUpgradeUpgradeList - `upgrade_list` V1ReleaseUpgradeInfo[] - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - `defined` boolean - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `function_reference` string - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - `declared_type` string - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `package_name` string - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `project_uuid` string, required — The UUID of the project to which this version upgrade relates. - `stats` V1ReleaseUpgradeStats - `cia_invocations` integer — CIA Invocations. - `compute_time` number, float — Compute time. - `data_load_time` number, float — Data load time. - `database_version_count` integer — The number of versions for direct dependencies we found in our database. - `dep_meta_count` integer — Dependency meta Count. - `dep_uuids` integer — Dependency UUIDs. - `direct_dependency_count` integer — Direct dependency count. - `direct_deps_count` integer — Direct cependencies count. - `direct_deps_package_count` integer — Direct dependencies package count. - `findings_after_filtering` integer — Findings after filtering. - `findings_fixed_by_upgrade_count` integer — Findings Fixed By Upgrade Count. - `findings_read` integer — Findings read. - `incomplete_releases` integer — Releases not considered because of lack of information. - `max_releases_behind` integer — Max Releases Behind. - `missing_version_count` integer — The number of direct dependency versions we miss from our database. - `namespace` string — Namespace. - `package_count` integer — Package Count. - `package_manager_version_count` integer — The number of versions for direct dependencies that we found in the package manager. - `pre_upgrade_findings_count` integer — Pre-upgrade Findings Count. - `project_name` string — Project Name. - `project_uuid` string — Project UUID. - `score_breakdown` object — Score breakdown. - `scores_read` integer — Scores read. - `skipped_due_to_cia` integer — Skipped due To CIA. - `upgrades_proposed` integer — Upgrades proposed. - `upgrades_reviewed` integer — Upgrades reviewed. - `upgrades_skipped` integer — Upgrades skipped. - `zero_conflict_upgrades_proposed` integer — Zero conflict upgrades proposed. - `upgrade_info` V1ReleaseUpgradeInfo — Protobuf definition for ReleaseUpgradeInfo. - `cia_results` V1VersionDiffResult[] — Details from the CIA analysis. - `confidence` 'CONFIDENCE_UNSPECIFIED' | 'CONFIDENCE_UNKNOWN' | 'CONFIDENCE_HIGH' | 'CONFIDENCE_MEDIUM' | 'CONFIDENCE_LOW' — Protobuf definition for Confidence. - `function_change` V1FunctionChange — Protobuf definition for FunctionChange. - `defined` boolean - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `function_reference` string - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `reachable_path` string[] - `type_change` V1TypeChange — Protobuf definition for TypeChange. - `declared_type` string - `diff_change` 'CHANGE_TYPE_UNSPECIFIED' | 'CHANGE_TYPE_ADDED' | 'CHANGE_TYPE_REMOVED' | 'CHANGE_TYPE_CHANGED' | 'CHANGE_TYPE_RENAMED' — Protobuf definition for ChangeType. - `id` string - `modifier_change` 'MODIFIER_CHANGE_TYPE_UNSPECIFIED' | 'MODIFIER_CHANGE_TYPE_SIGNATURE' | 'MODIFIER_CHANGE_TYPE_TO_ABSTRACT' | 'MODIFIER_CHANGE_TYPE_TO_FINAL' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PROTECTED' | 'MODIFIER_CHANGE_TYPE_PUBLIC_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_PROTECTED_TO_PRIVATE' | 'MODIFIER_CHANGE_TYPE_TO_STATIC' | 'MODIFIER_CHANGE_TYPE_TO_NONSTATIC' — Protobuf definition for ModifierChangeType. - `package_name` string - `violating_types` object - `cia_status` string — The status of the CIA analysis, including errors. - `conflicts` integer — The number of conflicts between the dependencies of the two versions. - `conflicts_map` object — The list of conflicting direct dependency packages. - `cur_dep_count` integer — The number of dependencies in the current version. - `current_conflicts` integer — The count of conflicts with even the current version. - `deps_added` integer — The number of new dependencies added in the upgrade. - `deps_removed` integer — The number of dependencies removed in the upgrade. - `direct_dependency_manifest_files` string[] — Manifest file information for the direct dependency being upgraded. - `direct_dependency_package` string — The package being upgraded. - `endor_scores_improvement` object - `from_pkg_version_uuid` string — The UUID of the package version of the current dependency version. - `from_version` string — The current version of the dependency. - `from_version_age_in_days` integer — Deprecated. - `from_version_publish_time` string, date-time — Publish time of the from version. - `is_best` boolean — Whether this the best upgrade according to our analysis or not. - `is_endor_patch` boolean — True if this is an Endor Labs Assured package version. - `is_latest` boolean — Whether this an upgrade to the latest version or not. - `minor_conflicts` integer — The number of minor (same major version) conflicts between the dependencies of the two versions. - `minor_conflicts_map` object — The list of minor (same major version) conflicts. - `other_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `package_count` integer — The number of packages affected by the upgrade. - `project` string — The name of the project. - `root_package_version` string — The project package that imports this dependency. - `root_pkg_version_uuid` string — The UUID of the root package version. - `score` integer — The internal score for this upgrade. - `score_explanation` string — The reasons for the score. - `to_pkg_version_uuid` string — The UUID of the package version of the dependency version to which we upgrade. - `to_version` string — The version to which the package is to be upgraded. - `to_version_age_in_days` integer — Deprecated. - `to_version_publish_time` string, date-time — Publish time of the to version. - `total_findings_fixed` integer — Count of findings (all types and severity levels) fixed by the upgrade. - `total_findings_introduced` integer — Count of findings (all types and severity levels) introduced by the upgrade. - `update_dep_count` integer — The number of dependencies in the upgrade. - `upgrade_risk` string — Upgrade risk. - `vuln_finding_info` V1FindingUpgradeBreakdown — Protobuf definition for FindingUpgradeBreakdown. - `current_count` integer — The finding count in the current version across all severities. - `fixed_findings` string[] — Fixed findings. - `reduction` integer — The reduction in findings across all severities. - `severity` object — The breakdown of finding information per severity level. - `upgrade_count` integer — The finding count in the upgrade version across all severities. - `worth_it` boolean — Whether the upgrade worth it or not. - `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 — The UUID of the resource. ## 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/revisions/2fe1f84213b3/schema)