--- title: "UpdateScanWorkflow" method: PATCH path: "/v1/namespaces/{object.tenant_meta.namespace}/scan-workflows" tags: ["ScanWorkflowService"] --- # UpdateScanWorkflow `PATCH /v1/namespaces/{object.tenant_meta.namespace}/scan-workflows` Updates the specified scan workflow with the information in the request body. ## Path parameters - `object.tenant_meta.namespace` string, required ## Request body - ScanWorkflowServiceUpdateScanWorkflowBody — Request used to update a scan workflow. - `object` object — ScanWorkflow corresponds to a workflow of scan steps. - `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` V1ScanWorkflowSpec - `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 - `bazel_exclude_targets` string[] — targets that should be excluded. - `bazel_include_targets` string[] — targets that should be included. - `bazel_show_internal_targets` boolean — show internal targets as dependencies. - `bazel_targets_query` string — query that should be used for bazel scans. - `bazel_workspace_path` string — bazel workspace path. - `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. - `remediation_parameters` V1RemediationParameters — RemediationParameters holds the settings for remediation actions. - `automated_pr_parameters` RemediationParametersAutomatedPRParameters — AutomatedPRParameters holds the settings for automated PRs. - `language_parameters` object — Language-specific parameters for the pull request. - `max_open_prs` integer — Maximum number of open pull requests allowed. - `steps` SpecWorkflowStep[] — The workflow steps. - `disabled` boolean — disable is a way to disable a WorkflowStep without having to delete it. - `scan_profile_uuid` string, required — scan_profile_uuid is the UUID of the ScanProfile of the workflow step. - `title` string, required — title is descriptive text of the workflow step. - `tenant_meta` object — The tenant to which the scan workflow belongs. - `uuid` string — The unique identifier of the scan workflow. - `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. - V1ScanWorkflow — ScanWorkflow corresponds to a workflow of scan steps. - `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` V1ScanWorkflowSpec, required - `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 - `bazel_exclude_targets` string[] — targets that should be excluded. - `bazel_include_targets` string[] — targets that should be included. - `bazel_show_internal_targets` boolean — show internal targets as dependencies. - `bazel_targets_query` string — query that should be used for bazel scans. - `bazel_workspace_path` string — bazel workspace path. - `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. - `remediation_parameters` V1RemediationParameters — RemediationParameters holds the settings for remediation actions. - `automated_pr_parameters` RemediationParametersAutomatedPRParameters — AutomatedPRParameters holds the settings for automated PRs. - `language_parameters` object — Language-specific parameters for the pull request. - `max_open_prs` integer — Maximum number of open pull requests allowed. - `steps` SpecWorkflowStep[] — The workflow steps. - `disabled` boolean — disable is a way to disable a WorkflowStep without having to delete it. - `scan_profile_uuid` string, required — scan_profile_uuid is the UUID of the ScanProfile of the workflow step. - `title` string, required — title is descriptive text of the workflow step. - `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 unique identifier of the scan workflow. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/revisions/2fe1f84213b3/schema)