Skip to main content
POST
Test a code repository connection

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Body

application/json
name
string

Always default — one repository per tenant

provider
string

Repository provider (github)

repo
string

Repository in owner/repo form

apiBaseUrl
string

API endpoint; override for GitHub Enterprise Server (e.g. https://ghes.example.com/api/v3)

branch
string
pathPrefix
string

Script path becomes {pathPrefix}{tapName}.py

authSecretName
string

Vault secret (tagged _type=repo_token) holding a token field. The token itself is never returned by the API.

commitAuthor
string

Commit author in Name <email> form

commitMessageTemplate
string

Commit message template. Tokens: {name}, {action}, {user}

enabled
boolean

Response

200 - application/json

Test outcome

ok
boolean
canPush
boolean
branchExists
boolean
defaultBranch
string
branches
string[]
error
string

Present when ok is false