Skip to main content
POST
/
v1
/
connectors
/
github
/
validate-target
Validate GitHub target
curl --request POST \
  --url https://api.openworklabs.com/v1/connectors/github/validate-target \
  --header 'Content-Type: application/json' \
  --data '
{
  "installationId": 123,
  "repositoryId": 123,
  "repositoryFullName": "<string>",
  "branch": "<string>",
  "ref": "<string>"
}
'
{
  "ok": true,
  "item": {
    "branchExists": true,
    "defaultBranch": "<string>",
    "repositoryAccessible": true
  }
}

Body

application/json
installationId
integer
required
Required range: x <= 9007199254740991
repositoryId
integer
required
Required range: x <= 9007199254740991
repositoryFullName
string
required
Required string length: 1 - 255
branch
string
required
Required string length: 1 - 255
ref
string
required
Required string length: 1 - 255

Response

GitHub target validated successfully.

ok
boolean
required
item
object
required