---
title: "Get a VCS Provider"
method: GET
path: "/vcs-providers/{vcs_provider}"
tags: ["vcs-providers"]
---

# Get a VCS Provider

`GET /vcs-providers/{vcs_provider}`

## Request

- Base URL: `https://example.scalr.io/api/iacp/v3`
- URL: `https://example.scalr.io/api/iacp/v3/vcs-providers/{vcs_provider}`
- Auth: HTTP bearer

Show details of a specific VCS provider.

## Path parameters

- `vcs_provider` string, required

## Query parameters

- `include` string[]
- `fields` object
  - `agent-pools` string: The comma-separated list of fields to return in response for AgentPool resource.
  - `vcs-providers` string: The comma-separated list of fields to return in response for VcsProvider resource.

## Response `200`

Success.

- VcsProviderDocument: JSON:API Document. see: https://jsonapi.org/format/#document-structure
  - `data` VcsProvider: The VCS Provider resource represents a connection between a Scalr account and a VCS, such as GitHub, Gitlab, Bitbucket, and Azure DevOps.
    - `attributes` object, required
      - `applies-enabled` boolean: Indicates whether triggering apply runs from a PR comment is enabled for this VCS provider.
      - `auth-type` 'oauth2' | 'personal_token', required: Authentication type, the VCS API client is using to establish connection with the VCS. * `oauth2` - private OAuth App, user or organization creates in their VCS account. Setup through this method requires a user to complete a [web flow through a browser](/docs/github), where the user should authorize Scalr to connect to their OAuth App. * `personal_token` - a pre-generated authentication token. This method works better if you need to fully automate the VCS provider creation. How to generate access tokens for different VCS providers: * [GitHub and GitHub Enterprise](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) * [GitLab and GitLab Enterprise](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html#creating-a-personal-access-token) * [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops-2019&tabs=preview-page) * [Bitbucket Data Center](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html)
      - `auto-merge` boolean: Designates whether to automatically merge the base branch into the head before run execution.
      - `comments-enabled` boolean: Indicates whether commenting on PRs is enabled for this VCS provider.
      - `compare-strategy` 'base-commit' | 'previous-commit': Designates which commit is compared with the head commit to produce diff changes.
      - `draft-pr-runs-enabled` boolean: Indicates whether the draft pull-request runs are enabled for this VCS provider.
      - `error-message` string, nullable: Contains error message, if the connection to VCS provider is broken.
      - `inaccessible-repos` string[]: Repository IDs that returned 403 for this VCS provider.
      - `is-shared` boolean: Indicates whether the VCS provider can be used in any account environments or only linked one.
      - `name` string, required: VCS provider name, which must be unique within the account.
      - `plans-enabled` boolean: Indicates whether triggering dry runs from a PR comment is enabled for this VCS provider.
      - `pr-merge-comments-enabled` boolean: Indicates whether comment should be posted on PR after merge with results of triggered runs.
      - `report-method` 'commit-status' | 'check' | 'both': Designates where run results are reported in the VCS. `check` and `both` are available only for GitHub providers connected through the Scalr GitHub App.
      - `report-mode` 'per-workspace' | 'cumulative': Designates how run results are grouped when reported.
      - `token` string, nullable: Access token for an API client for using to connect to the VCS Provider.
      - `url` string, uri, nullable: The URL to the VCS provider installation. Required for GitHub Enterprise, GitLab Enterprise and Bitbucket Data Center. For GitHub it may be set to a GitHub Enterprise Cloud with data residency tenant URL (`https://<subdomain>.ghe.com`).
      - `username` string, nullable: Username for personal_token auth type. This field is required for bitbucket_enterprise provider.
      - `vcs-type` 'github' | 'gitlab' | 'bitbucket' | 'bitbucket_enterprise' | 'gitlab_enterprise' | 'github_enterprise' | 'azure_dev_ops_services', required: VCS provider type.
    - `id` string
    - `links` object
      - `self` string
    - `relationships` object
      - `account` object: The account that owns this VCS integration.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'accounts' | '', required
      - `agent-pool` object: The ID of the agent pool to communicate with on-prem VCS provider that not accessible directly.
        - `data` object, nullable, required
          - `id` string, required
          - `type` 'agent-pools' | '', required
      - `environments` object: The list of environments this VCS integration is linked to.
        - `data` object[], nullable, required
          - `id` string, required
          - `type` 'environments' | '', required
    - `type` 'vcs-providers', required
  - `included` object[]
  - `meta` object

## Other responses

- `404`: VCS provider not found or user unauthorized to perform action.
- `4XX`: Client error.
- `5XX`: Server error.

## Changes

- **2026-11-03** `d3e1dc85657a`: 1 warning, 2 info
  - removed the optional property `data/attributes/checks-enabled` from the response with the `200` status
  - added the optional property `data/attributes/report-method` to the response with the `200` status
  - added the optional property `data/attributes/report-mode` to the response with the `200` status

[Operation history](https://skmtc.dev/scalr/apis/scalr-iacp-api/changes/vcs-providers/:vcs_provider/get.md)

---

[API](https://skmtc.dev/scalr/apis/scalr-iacp-api.md) - [All operations](https://skmtc.dev/scalr/apis/scalr-iacp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalr/apis/scalr-iacp-api/revisions/d3e1dc85657a?raw)