Get repository

GET

/api/v2/code-refs/repositories/:repo

GET

/api/v2/code-refs/repositories/:repo

1 curl https://app.launchdarkly.com/api/v2/code-refs/repositories/repo \
2      -H "Authorization: <apiKey>"

Try it

200Retrieved

1 {
2   "name": "LaunchDarkly-Docs",
3   "type": "github",
4   "defaultBranch": "main",
5   "enabled": true,
6   "version": 3,
7   "_links": {},
8   "sourceLink": "https://github.com/launchdarkly/LaunchDarkly-Docs",
9   "commitUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/commit/${sha}",
10   "hunkUrlTemplate": "https://github.com/launchdarkly/LaunchDarkly-Docs/blob/${sha}/${filePath}#L${lineNumber}",
11   "branches": [
12     {
13       "name": "main",
14       "head": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
15       "syncTime": 1,
16       "_links": {},
17       "updateSequenceId": 25,
18       "references": [
19         {
20           "path": "/main/index.js",
21           "hunks": [
22             {
23               "startingLineNumber": 45,
24               "lines": "var enableFeature = 'enable-feature';",
25               "projKey": "default",
26               "flagKey": "enable-feature",
27               "aliases": [
28                 "enableFeature",
29                 "EnableFeature"
30               ]
31             }
32           ],
33           "hint": "javascript"
34         }
35       ]
36     }
37   ],
38   "_access": {
39     "denied": [
40       {
41         "action": "string",
42         "reason": {
43           "effect": "allow",
44           "resources": [
45             "proj/*:env/*;qa_*:/flag/*"
46           ],
47           "notResources": [
48             "string"
49           ],
50           "actions": [
51             "*"
52           ],
53           "notActions": [
54             "string"
55           ],
56           "role_name": "string"
57         }
58       }
59     ],
60     "allowed": [
61       {
62         "action": "string",
63         "reason": {
64           "effect": "allow",
65           "resources": [
66             "proj/*:env/*;qa_*:/flag/*"
67           ],
68           "notResources": [
69             "string"
70           ],
71           "actions": [
72             "*"
73           ],
74           "notActions": [
75             "string"
76           ],
77           "role_name": "string"
78         }
79       }
80     ]
81   }
82 }

Get a single repository by name.

Authentication

Authorizationstring

API Key authentication via header

Path Parameters

repostringRequiredformat: "string"

The repository name

Response

Repository response

namestring

The repository name

typeenum

The type of repository

Allowed values:

defaultBranchstring

The repository's default branch

enabledboolean

Whether or not a repository is enabled for code reference scanning

versioninteger

The version of the repository's saved information

_linksmap from strings to any

sourceLinkstring or null

A URL to access the repository

commitUrlTemplatestring or null

A template for constructing a valid URL to view the commit

hunkUrlTemplatestring or null

A template for constructing a valid URL to view the hunk

brancheslist of objects or null

An array of the repository's branches that have been scanned for code references

_accessobject or null

Authentication

Path Parameters

Response

Errors