Upload References
POST/v1/code-references
Request
- application/json
- text/json
- application/*+json
Body
required
Array [
Array [
Array [
]
Array [
]
]
]
The Config's identifier the scanning was performed against.
Possible values: non-empty and <= 255 characters
The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)
Possible values: non-empty and <= 255 characters
The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The related commit's URL. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The related commit's hash. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The scanning tool's name. (Appears on the ConfigCat Dashboard)
The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.
flagReferences
object[]
nullable
The actual code reference collection.
The identifier of the Feature Flag or Setting the code reference belongs to.
references
object[]
required
The actual references to the given Feature Flag or Setting.
Possible values: non-empty and <= 255 characters
The file's name in where the code reference has been found. (Appears on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The file's url. (Used to point to the file on the repository's website)
preLines
object[]
nullable
The lines before the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
postLines
object[]
nullable
The lines after the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
referenceLine
object
required
Determines a code reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
Body
required
Array [
Array [
Array [
]
Array [
]
]
]
The Config's identifier the scanning was performed against.
Possible values: non-empty and <= 255 characters
The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)
Possible values: non-empty and <= 255 characters
The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The related commit's URL. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The related commit's hash. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The scanning tool's name. (Appears on the ConfigCat Dashboard)
The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.
flagReferences
object[]
nullable
The actual code reference collection.
The identifier of the Feature Flag or Setting the code reference belongs to.
references
object[]
required
The actual references to the given Feature Flag or Setting.
Possible values: non-empty and <= 255 characters
The file's name in where the code reference has been found. (Appears on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The file's url. (Used to point to the file on the repository's website)
preLines
object[]
nullable
The lines before the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
postLines
object[]
nullable
The lines after the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
referenceLine
object
required
Determines a code reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
Body
required
Array [
Array [
Array [
]
Array [
]
]
]
The Config's identifier the scanning was performed against.
Possible values: non-empty and <= 255 characters
The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)
Possible values: non-empty and <= 255 characters
The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The related commit's URL. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The related commit's hash. (Appears on the ConfigCat Dashboard)
Possible values: <= 255 characters
The scanning tool's name. (Appears on the ConfigCat Dashboard)
The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.
flagReferences
object[]
nullable
The actual code reference collection.
The identifier of the Feature Flag or Setting the code reference belongs to.
references
object[]
required
The actual references to the given Feature Flag or Setting.
Possible values: non-empty and <= 255 characters
The file's name in where the code reference has been found. (Appears on the ConfigCat Dashboard)
Possible values: <= 1000 characters
The file's url. (Used to point to the file on the repository's website)
preLines
object[]
nullable
The lines before the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
postLines
object[]
nullable
The lines after the actual reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
referenceLine
object
required
Determines a code reference line.
Possible values: <= 1000 characters
The content of the reference line.
The line number.
Responses
- 200
- 400
- 404
- 429
Success
Bad request.
Not found.
Too many requests. In case of the request rate exceeds the rate limits.