Skip to main content
GET
Get Repo File Tree

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required
owner
string
required
repo
string
required

Query Parameters

ref
string
required

Branch name or commit SHA to retrieve the file tree for

path
string

Directory path within the repository (defaults to the repository root)

Response

The hierarchical file tree of the GitHub repository at the requested ref.

totalCount
integer

Total number of entries in the repository tree before filtering.

tree
array

Root-level tree nodes, each with name, path, type (file or dir), size, sha, and nested children.

truncated
boolean

Whether GitHub truncated the tree because the repository is too large.