GitHub

Get GitHub integration

Changed on

Get the GitHub integration for a project, or null when none is configured.

get/github-integration/project/{projectId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/github-integration/project/{projectId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Response

GitHub integration details, or null

idstring required
projectIdstring required
repositoryOwnerstring required
repositoryNamestring required
installationIdnumber nullable required

The GitHub App installation that grants access to the repository.

requiresVerificationboolean required
branchPatternstring

Template used to name branches created for a task.

commentTaskLinkOnGitHubIssueboolean

When on, Kaneo comments a link back to the task on the linked GitHub issue.

isActiveboolean nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status