Skip to main content
Use the Codebases API to find the repository IDs required by the Issues API and the Scanning API.

​
List Codebases

The path is codebase (singular). Send your API key in the x-vidoc-token header. The route requires issue:view. The API returns all codebases that are not deleted in the key’s project. It does not list projects or repositories from other projects. To read another project, use a key for that project.

​
Example Request

​
Response

200 OK returns a JSON array. There is no pagination and no codebases or data wrapper. A project with no codebases returns []. This example shows selected fields. The API also returns other codebase fields.

​
Read Issues for a Codebase

Copy an id from the list response:
Use the repository’s branch name in branch. Issue results are paginated; see List Issues to read the remaining pages.

​
Get One Codebase

This route requires issue:view and returns one codebase object from the key’s project.

​
List Files in a Branch

This route requires issue:view. The branchName parameter is required. It is named branchName here and branch in issue-list and scan-start requests. The response has the shape { "files": [...] }. Each item contains fileId, filePath, version, isIndexed, and isScanned. Use fileId to scan specific files.

​
Authentication Errors

A missing key returns 401 Token is missing. An invalid or expired key returns 401 Invalid or expired token. See API Authentication for the host, header, permissions, and error format.