Skip to main content
POST
Analyze a GitHub repository

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Body

application/json
repositoryUrl
string<uri>
required
connection_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
workspace_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ref
string
Required string length: 1 - 255
suggestPaths
boolean

Response

Successful response

label
string
required
Required string length: 1 - 200
ref
string
required
Required string length: 1 - 255
includePaths
string[]
required
Maximum array length: 100
Required string length: 1 - 1024
excludePaths
string[]
required
Maximum array length: 100
Required string length: 1 - 1024
confidence
number
required
Required range: 0 <= x <= 1
notes
string | null
required
Required string length: 1 - 1000
fileCount
integer
required
Required range: 0 <= x <= 9007199254740991
defaultBranch
string
required
Minimum string length: 1
latestRelease
object
required
files
string[]
required
Minimum string length: 1