Skip to main content
POST
Check scan repository access

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json
repoUrl
string
required

Repository URL the scan would clone, e.g. https://github.com/owner/repo

Example:

"https://github.com/acme/storefront"

Response

200 - application/json
ok
boolean
required

True when the repository can be cloned: it exists and, when the organization has a GitHub connection, that connection can see it.

Example:

true

visibility
enum<string>

Repository visibility as GitHub reports it.

Available options:
public,
private,
internal
Example:

"private"

defaultBranch
string

Default branch the clone would check out.

Example:

"main"

fullName
string

Repository full name as GitHub reports it.

Example:

"acme/storefront"

reason
string

Customer-safe sentence explaining why the repository is not reachable. Present only when ok is false.

Example:

"No GitHub connection is configured for this organization"