GitHub API

In this Article

Overview

You can update Projects that are synchronized with GitHub repositories by using the APIs described in this article. Use these APIs with Continuous-Integration/Continuous-Deployment workflows to pull changes from one development stage to another and checkout GitHub repositories. You still need commit changes through the Manager interface. The Authorization type supported by the APIs is Basic Auth.


Pull Request

Pull changes from a branch into the specified project. You must have already created the project and done a checkout of the branch in the Manager UI prior to calling this endpoint. This endpoint can be useful to update a project with the latest changes on a branch for testing.

Syntax

Example

Sample Request and Response


Checkout Repository

Do a checkout of the repository at the given reference into the project at the specified path. You must create the project first and do a checkout in the Manager UI before calling this endpoint. This endpoint can be useful to update a project to a newly tagged version or revert to a previously stable tag. You need to provide the repository path in the body of the call. 

Parameter

KeyValue
ref

For specifying the GIT reference to checkout. 

Default: heads/master

Example: 

{"ref" : "heads/master"}

The parameter's key-value pair should be passed in JSON format.

Syntax

Example

Sample Request and Response