---
title: "List SCMConfig"
method: GET
path: "/api/scm/deployments/{deploymentId}/configs"
tags: ["ScmService"]
---

# List SCMConfig

`GET /api/scm/deployments/{deploymentId}/configs`

List all SCM configs for a deployment.

## Path parameters

- `deploymentId` string, required

## Query parameters

- `limit` string
- `cursor` string
- `sortDirection` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC', enum
- `sortBy` 'SCM_CONFIG_SORT_BY_UNSPECIFIED' | 'SCM_CONFIG_SORT_BY_NAME' | 'SCM_CONFIG_SORT_BY_ID' | 'SCM_CONFIG_SORT_BY_LAST_SUCCESSFUL_SYNC_AT', enum

## Response `200`

OK

- ProtosScmV1ListScmConfigResponse
  - `configs` ProtosScmV1ScmConfig[] — a list of SCM configs for this deployment
    - `id` string — the unique id of the config
    - `type` 'SCM_TYPE_GITHUB' | 'SCM_TYPE_GITHUB_ENTERPRISE' | 'SCM_TYPE_GITLAB' | 'SCM_TYPE_GITLAB_SELFMANAGED' | 'SCM_TYPE_BITBUCKET' | 'SCM_TYPE_BITBUCKET_DATACENTER' | 'SCM_TYPE_AZURE_DEVOPS' | 'SCM_TYPE_UNKNOWN' | 'SCM_TYPE_HARNESS', enum — the type of the source code manager that this config is for | value | description | |-------|---------------| | SCM_TYPE_GITHUB | GitHub Cloud | | SCM_TYPE_GITHUB_ENTERPRISE | GitHub Enterprise | | SCM_TYPE_GITLAB | GitLab Cloud | | SCM_TYPE_GITLAB_SELFMANAGED | GitLab Self-Managed | | SCM_TYPE_BITBUCKET | Bitbucket Cloud | | SCM_TYPE_BITBUCKET_DATACENTER | Bitbucket Data Center | | SCM_TYPE_AZURE_DEVOPS | Azure DevOps | | SCM_TYPE_UNKNOWN | | | SCM_TYPE_HARNESS | Harness |
    - `namespace` string — the namespace of the config (e.g. GitHub org, GitLab group, etc.)
    - `sourceId` string
    - `baseUrl` string
    - `app` ProtosScmV1ScmApp
      - `id` string
      - `slug` string
      - `appId` string
      - `scmType` 'SCM_TYPE_GITHUB' | 'SCM_TYPE_GITHUB_ENTERPRISE' | 'SCM_TYPE_GITLAB' | 'SCM_TYPE_GITLAB_SELFMANAGED' | 'SCM_TYPE_BITBUCKET' | 'SCM_TYPE_BITBUCKET_DATACENTER' | 'SCM_TYPE_AZURE_DEVOPS' | 'SCM_TYPE_UNKNOWN' | 'SCM_TYPE_HARNESS', enum — | value | description | |-------|---------------| | SCM_TYPE_GITHUB | GitHub Cloud | | SCM_TYPE_GITHUB_ENTERPRISE | GitHub Enterprise | | SCM_TYPE_GITLAB | GitLab Cloud | | SCM_TYPE_GITLAB_SELFMANAGED | GitLab Self-Managed | | SCM_TYPE_BITBUCKET | Bitbucket Cloud | | SCM_TYPE_BITBUCKET_DATACENTER | Bitbucket Data Center | | SCM_TYPE_AZURE_DEVOPS | Azure DevOps | | SCM_TYPE_UNKNOWN | | | SCM_TYPE_HARNESS | Harness |
      - `baseUrl` string
      - `requestId` string
      - `scmName` string
      - `codeAccess` boolean
      - `tenantId` string — Entra tenant ID, unset for other SCM types
    - `status` ProtosScmV1ScmStatus
      - `checked` string, date-time
      - `ok` boolean
      - `error` string
    - `installed` boolean
    - `suspended` boolean
    - `githubEntityType` 'GITHUB_ENTITY_TYPE_ORG' | 'GITHUB_ENTITY_TYPE_USER', enum — the type of GitHub entity (org or personal) | value | description | |-------|---------------| | GITHUB_ENTITY_TYPE_ORG | | | GITHUB_ENTITY_TYPE_USER | |
    - `autoScan` boolean
    - `useNetworkBroker` boolean
    - `tokenScopes` ProtosScmV1ScmTokenScopes
      - `readMetadata` boolean
      - `readPullRequest` boolean
      - `writePullRequestComment` boolean
      - `readContents` boolean
      - `readMembers` boolean
      - `manageWebhooks` boolean
      - `writeContents` boolean
      - `writePullRequest` boolean
    - `subscriptions` ProtosScmV1ScmWebhookSubscription[]
      - `scmUrl` string
      - `events` string[]
    - `lastSuccessfulSyncAt` string, date-time
    - `autoScanSettings` ProtosScmV1AutoScanSettings
      - `diffEnabled` boolean
    - `hasAccessToken` boolean — True when the config has an access token (e.g. a GitHub PAT). Independent of `app`: a private app installation may also have an access token.
    - `scmId` string
  - `cursor` string

---

[API](https://skmtc.net/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.net/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/versions/6483eeecd582/schema)
