Skip to main content
Check whether this workspace can read a repository

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

owner
string
required

GitHub owner of the repository.

Required string length: 1 - 100
repo
string
required

GitHub repository name.

Required string length: 1 - 100

Query Parameters

ref
string

Branch, tag or commit to check instead of the default branch.

Required string length: 1 - 256

Response

Whether the repository is readable, with the detected recipe when it is.

Whether the workspace can read one repository, and what a launch would do with it.

repo
string
required

Repository as owner/name.

readable
boolean
required
visibility
enum<string> | null
required

public, or private when read through the workspace's GitHub connection; null when unreadable.

Available options:
public,
private,
null
sha
string | null
required

Commit the checked ref points at; null when unreadable.

files
string[] | null
required

Top-level entries at sha, directories ending in a slash; null when unreadable or the listing failed.

recipe
object | null
required
code
string

Machine-readable refusal code; present only when readable is false.

message
string

Why the repository cannot be read; present only when readable is false.

fix
string

What to do about it; present only when readable is false.