---
title: "GetScanProfile returns a toolchain profile specified by its UUID."
method: GET
path: "/v1/namespaces/{tenant_meta.namespace}/scan-profiles/{uuid}"
tags: ["ScanProfileService"]
---

# GetScanProfile returns a toolchain profile specified by its UUID.

`GET /v1/namespaces/{tenant_meta.namespace}/scan-profiles/{uuid}`

## Path parameters

- `tenant_meta.namespace` string, required
- `uuid` string, required

## Query parameters

- `get_parameters.mask` string

## Response `200`

A successful response.

- 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
        - `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.
    - `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.
        - `language_parameters` object — Language-specific parameters for the pull request.
        - `max_open_prs` integer — Maximum number of open pull requests allowed.
    - `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.

## 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)