--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # Get a VCS Provider Show details of a specific VCS provider. # OpenAPI definition ```json { "components": { "schemas": { "VcsProvider": { "description": "The VCS Provider resource represents a connection between a Scalr\naccount and a VCS, such as GitHub, Gitlab, Bitbucket, and Azure DevOps.", "properties": { "attributes": { "properties": { "applies-enabled": { "default": false, "description": "Indicates whether triggering apply runs from a PR comment is enabled for this VCS provider.", "type": "boolean" }, "auth-type": { "description": "Authentication type, the VCS API client is using to establish connection with the VCS.\n\n* `oauth2` - private OAuth App, user or organization creates in their VCS account.\nSetup through this method requires a user to complete a\n[web flow through a browser](/docs/github),\nwhere the user should authorize Scalr to connect to their OAuth App.\n\n* `personal_token` - a pre-generated authentication token. This method works better if\n you need to fully automate the VCS provider creation.\n\n How to generate access tokens for different VCS providers:\n * [GitHub and GitHub Enterprise](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)\n * [GitLab and GitLab Enterprise](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html#creating-a-personal-access-token)\n * [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)\n * [Bitbucket Data Center](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html)", "enum": [ "oauth2", "personal_token" ], "type": "string" }, "auto-merge": { "default": false, "description": "Designates whether to automatically merge the base branch into the head before run execution.", "type": "boolean" }, "comments-enabled": { "default": false, "description": "Indicates whether commenting on PRs is enabled for this VCS provider.", "type": "boolean" }, "compare-strategy": { "default": "base-commit", "description": "Designates which commit is compared with the head commit to produce diff changes.", "enum": [ "base-commit", "previous-commit" ], "type": "string" }, "draft-pr-runs-enabled": { "default": false, "description": "Indicates whether the draft pull-request runs are enabled for this VCS provider.", "type": "boolean" }, "error-message": { "description": "Contains error message, if the connection to VCS provider is broken.", "nullable": true, "readOnly": true, "type": "string" }, "inaccessible-repos": { "description": "Repository IDs that returned 403 for this VCS provider.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "is-shared": { "description": "Indicates whether the VCS provider can be used in any account environments or only linked one.", "type": "boolean" }, "name": { "description": "VCS provider name, which must be unique within the account.", "maxLength": 255, "minLength": 1, "pattern": "^[ A-Za-z0-9_-]+$", "type": "string" }, "plans-enabled": { "default": false, "description": "Indicates whether triggering dry runs from a PR comment is enabled for this VCS provider.", "type": "boolean" }, "pr-merge-comments-enabled": { "default": false, "description": "Indicates whether comment should be posted on PR after merge with results of triggered runs.", "type": "boolean" }, "report-method": { "default": "commit-status", "description": "Designates where run results are reported in the VCS. `check` and `both` are available only for GitHub providers connected through the Scalr GitHub App.", "enum": [ "commit-status", "check", "both" ], "type": "string" }, "report-mode": { "default": "per-workspace", "description": "Designates how run results are grouped when reported.", "enum": [ "per-workspace", "cumulative" ], "type": "string" }, "token": { "description": "Access token for an API client for using to connect to the VCS Provider.", "nullable": true, "type": "string" }, "url": { "description": "The URL to the VCS provider installation.\nRequired for GitHub Enterprise, GitLab Enterprise and Bitbucket Data Center.\nFor GitHub it may be set to a GitHub Enterprise Cloud with data residency\ntenant URL (`https://.ghe.com`).", "format": "uri", "maxLength": 255, "minLength": 1, "nullable": true, "type": "string" }, "username": { "description": "Username for personal_token auth type. This field is required for bitbucket_enterprise provider.", "maxLength": 255, "nullable": true, "type": "string" }, "vcs-type": { "description": "VCS provider type.", "enum": [ "github", "gitlab", "bitbucket", "bitbucket_enterprise", "gitlab_enterprise", "github_enterprise", "azure_dev_ops_services" ], "type": "string" } }, "required": [ "name", "vcs-type", "auth-type" ], "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "properties": { "self": { "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" }, "relationships": { "properties": { "account": { "description": "The account that owns this VCS integration.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "accounts", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "agent-pool": { "description": "The ID of the agent pool to communicate with on-prem VCS provider that not accessible directly.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "agent-pools", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "environments": { "description": "The list of environments this VCS integration is linked to.", "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "environments", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "enum": [ "vcs-providers" ], "type": "string" } }, "required": [ "type", "attributes" ], "type": "object" }, "VcsProviderDocument": { "description": "JSON:API Document.\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "$ref": "#/components/schemas/VcsProvider" }, "included": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "meta": { "readOnly": true, "type": "object" } }, "type": "object" } }, "securitySchemes": { "API-Key": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Scalr IACP API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "title": "Scalr IACP API", "version": "unversioned" }, "openapi": "3.0.0", "paths": { "/vcs-providers/{vcs_provider}": { "get": { "description": "Show details of a specific VCS provider.", "operationId": "get_vcs_provider", "parameters": [ { "description": "The ID of the VCS provider.", "in": "path", "name": "vcs_provider", "required": true, "schema": { "type": "string" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "agent-pool" ], "type": "string" }, "type": "array" } }, { "description": "The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.", "explode": true, "in": "query", "name": "fields", "required": false, "schema": { "properties": { "agent-pools": { "description": "The comma-separated list of fields to return in response for AgentPool resource.", "type": "string" }, "vcs-providers": { "description": "The comma-separated list of fields to return in response for VcsProvider resource.", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "examples": { "default": { "value": "{\n \"data\": {\n \"attributes\": {\n \"auth-type\": \"personal_token\",\n \"name\": \"default\",\n \"url\": \"https://github.com\",\n \"vcs-type\": \"github\"\n },\n \"id\": \"vcs-tk8dllqje1rav31\",\n \"links\": {\n \"self\": \"https://my.scalr.io/api/iacp/v3/vcs-providers/vcs-tk8dllqje1rav31\"\n },\n \"relationships\": {\n \"account\": null,\n \"environment\": null\n },\n \"type\": \"vcs-providers\"\n },\n \"included\": null,\n \"meta\": null\n}" } }, "schema": { "$ref": "#/components/schemas/VcsProviderDocument" } } }, "description": "Success." }, "404": { "description": "VCS provider not found or user unauthorized to perform action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "Get a VCS Provider", "tags": [ "vcs-providers" ], "x-mcp-tool": true, "x-resource": "VcsProvider", "x-service": "tf-api" } } }, "security": [ { "API-Key": [] } ], "servers": [ { "url": "https://{Domain}/api/iacp/v3", "variables": { "Domain": { "default": "example.scalr.io", "description": "Domain where Scalr is hosted" } } } ] } ``` # Sibling pages * [List VCS Providers](https://docs.scalr.io/scalr/reference/list_vcs_providers.md) * [Create a VCS Provider](https://docs.scalr.io/scalr/reference/create_vcs_provider.md) * [Delete a VCS Provider](https://docs.scalr.io/scalr/reference/delete_vcs_provider.md) * [Update a VCS Provider](https://docs.scalr.io/scalr/reference/update_vcs_provider.md)