Connect a GitHub repository to a project
const url = 'https://zkao.io/api/v1/organizations/example/projects/example/repositories';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"owner":"example","name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://zkao.io/api/v1/organizations/example/projects/example/repositories \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "owner": "example", "name": "example" }'Requires an organization token with scope repositories:write. The same checks as the dashboard apply. A private repository needs the zkao GitHub App installed for it, and the member who created the token must have access to it on GitHub with a verified GitHub account. A new repository is analyzing until its first pass finishes.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The organization’s id, as GET /token reports it.
Request Bodyrequired
Section titled “Request Bodyrequired”object
GitHub user or organization.
Repository name.
Examplegenerated
{ "owner": "example", "name": "example"}Responses
Section titled “ Responses ”Created
object
object
URL segment of the repository inside its project (/orgs/<org>/projects/<project>/repos/<slug>). Unique per project.
ACTIVE | MARKED_FOR_DELETION
Whether a scan can start on this repository. A newly added repository is analyzing until a one-time pass over it finishes; launching a scan meanwhile fails with repository_initializing. Poll this endpoint rather than retrying the launch blind.
Example
{ "repository": { "readiness": "ready" }}Invalid request
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Missing, malformed, expired, or revoked token
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}The token is a project token, or lacks the required scope
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Resource not in this token’s project or repo allowlist
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}The repository is already in the project (code conflict)
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Rate limited. Either the token’s spend limit for the current period is reached (on launch), or the token is sending too many requests. Wait the number of seconds in the Retry-After header before retrying.
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Headers
Section titled “Headers”Seconds to wait before retrying.
