---
updatedAt: 2026-06-15T12:34:52.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/artifactory/llms.txt
---

# Get VCS Refs

Downloads a VCS Git References file.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "JFrog Artifactory Package Type Specific APIs",
    "description": "REST API for package-type-specific operations in JFrog Artifactory: endpoints that depend on package type\nor format (Puppet Forge, metadata calculation/reindex, PyPI JSON API, VCS) rather than generic repository CRUD.\n\n## Puppet\nPuppet Forge API v3–compatible endpoints under `/puppet/{repoKey}/v3/...`.\n\n## Metadata calculation\nReindex and metadata operations per package type (Alpine, Maven, npm, Debian, Helm, PyPI JSON API, etc.).\n\n## VCS\nVersion control integration: tags, branches, downloads, and archives from VCS-backed repositories.\n\nFollow `TEMPLATE.yaml` in the repository root for response codes, `ErrorResponse`, and parameter constraints.\n",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}/artifactory/api",
      "description": "JFrog Platform",
      "variables": {
        "jfrog_url": {
          "default": "myserver.jfrog.io",
          "description": "Your JFrog Platform hostname (e.g., mycompany.jfrog.io)"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "VCS",
      "description": "Version Control System repository operations"
    }
  ],
  "paths": {
    "/vcs/refs/{repoKey}/{userOrg}/{repo}": {
      "get": {
        "tags": [
          "VCS"
        ],
        "summary": "Get VCS Refs",
        "description": "Downloads a VCS Git References file.",
        "operationId": "getVcsRefs",
        "parameters": [
          {
            "name": "repoKey",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The repository key"
          },
          {
            "name": "userOrg",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The user organization"
          },
          {
            "name": "repo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The repository name"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "Bad Credentials - The provided authentication is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "description": "Permission Denied - The user does not have the necessary permissions to perform this action.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    },
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-JFrog-Art-Api"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```