v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Code references

Create repository

Create a repository with the specified name.

post/api/v2/code-refs/repositories

Request body

namestring required

The repository name

sourceLinkstring

A URL to access the repository

commitUrlTemplatestring

A template for constructing a valid URL to view the commit

hunkUrlTemplatestring

A template for constructing a valid URL to view the hunk

type'bitbucket' | 'custom' | 'github' | 'gitlab'

The type of repository. If not specified, the default value is <code>custom</code>.

defaultBranchstring

The repository's default branch. If not specified, the default value is <code>main</code>.

Example request

{
  "name": "LaunchDarkly-Docs",
  "sourceLink": "https://github.com/launchdarkly/LaunchDarkly-Docs",
  "commitUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/commit/${sha}",
  "hunkUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/blob/${sha}/${filePath}#L${lineNumber}",
  "type": "github",
  "defaultBranch": "main"
}

Response

Repository response

namestring required

The repository name

sourceLinkstring

A URL to access the repository

commitUrlTemplatestring

A template for constructing a valid URL to view the commit

hunkUrlTemplatestring

A template for constructing a valid URL to view the hunk

type'bitbucket' | 'custom' | 'github' | 'gitlab' required

The type of repository

defaultBranchstring required

The repository's default branch

enabledboolean required

Whether or not a repository is enabled for code reference scanning

versioninteger required

The version of the repository's saved information

_linksobject required

Example response

{
  "name": "LaunchDarkly-Docs",
  "sourceLink": "https://github.com/launchdarkly/LaunchDarkly-Docs",
  "commitUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/commit/${sha}",
  "hunkUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/blob/${sha}/${filePath}#L${lineNumber}",
  "type": "github",
  "defaultBranch": "main",
  "enabled": true,
  "version": 3,
  "branches": [
    {
      "name": "main",
      "head": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "updateSequenceId": 25,
      "references": [
        {
          "path": "/main/index.js",
          "hint": "javascript",
          "hunks": [
            {
              "startingLineNumber": 45,
              "lines": "var enableFeature = 'enable-feature';",
              "projKey": "default",
              "flagKey": "enable-feature",
              "aliases": [
                "enableFeature",
                "EnableFeature"
              ]
            }
          ]
        }
      ]
    }
  ],
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  }
}