List Forge GitHub Integrations

List available Forge GitHub integrations.

GET /v1/integrations/forge/github/install

List Forge GitHub Integrations

cURL

curl --request GET \
  --url https://api.example.com/v1/integrations/forge/github/install

import requests

url = "https://api.example.com/v1/integrations/forge/github/install"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/integrations/forge/github/install', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/integrations/forge/github/install",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/integrations/forge/github/install"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/integrations/forge/github/install")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/integrations/forge/github/install")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "installation_id": 123,
    "name": "<string>",
    "repository_selection": "<string>",
    "settings_url": "<string>"
  }
]

Response

200 - application/json

Successful Response

id · string<uuid> · required

GitHub Integration ID.

For example, in the POST /v2/deployments request body, set integration_id to the value of this field.

installation_id · integer · required

GitHub installation ID.

name · string · required

GitHub accout name.

repository_selection · string | null

Whether the GitHub App install grants access to 'all' repos or only 'selected' ones. When 'selected', newly created repos are not auto-included and must be added on GitHub.

settings_url · string | null

Deep link to the install's GitHub settings page, where repo access can be edited. GitHub's installation html_url.