Link a repository to an app
curl --request POST \
--url https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repositoryFullname": "your-github-username/my-repo",
"settings": {
"branches": [
"main"
],
"autoDeploy": true,
"checkSuite": false
}
}
'import requests
url = "https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}"
payload = {
"repositoryFullname": "your-github-username/my-repo",
"settings": {
"branches": ["main"],
"autoDeploy": True,
"checkSuite": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repositoryFullname: 'your-github-username/my-repo',
settings: {branches: ['main'], autoDeploy: true, checkSuite: false}
})
};
fetch('https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}', 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.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repositoryFullname' => 'your-github-username/my-repo',
'settings' => [
'branches' => [
'main'
],
'autoDeploy' => true,
'checkSuite' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}"
payload := strings.NewReader("{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid team ID.",
"data": null
}{
"error": "Unauthorized."
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>",
"data": {
"code": "<string>"
}
}{
"statusCode": 404,
"error": "Not Found",
"message": "Repository not found.",
"data": {
"code": "repository_not_found"
}
}{
"statusCode": 409,
"error": "Conflict",
"message": "Repository already connected.",
"data": {
"code": "repository_already_connected"
}
}App Repository
Link a repository to an app
Links a repository to an app. With autoDeploy, new commits on the chosen branch are deployed automatically; with checkSuite, deploys wait for the commit’s checks on GitHub to finish. An app can have only one linked repository. Team permission: operate or manage.
POST
/
v1
/
projects
/
{projectID}
/
git-repository-integration
/
{provider}
Link a repository to an app
curl --request POST \
--url https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repositoryFullname": "your-github-username/my-repo",
"settings": {
"branches": [
"main"
],
"autoDeploy": true,
"checkSuite": false
}
}
'import requests
url = "https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}"
payload = {
"repositoryFullname": "your-github-username/my-repo",
"settings": {
"branches": ["main"],
"autoDeploy": True,
"checkSuite": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repositoryFullname: 'your-github-username/my-repo',
settings: {branches: ['main'], autoDeploy: true, checkSuite: false}
})
};
fetch('https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}', 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.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repositoryFullname' => 'your-github-username/my-repo',
'settings' => [
'branches' => [
'main'
],
'autoDeploy' => true,
'checkSuite' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}"
payload := strings.NewReader("{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liara.ir/v1/projects/{projectID}/git-repository-integration/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repositoryFullname\": \"your-github-username/my-repo\",\n \"settings\": {\n \"branches\": [\n \"main\"\n ],\n \"autoDeploy\": true,\n \"checkSuite\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid team ID.",
"data": null
}{
"error": "Unauthorized."
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>",
"data": {
"code": "<string>"
}
}{
"statusCode": 404,
"error": "Not Found",
"message": "Repository not found.",
"data": {
"code": "repository_not_found"
}
}{
"statusCode": 409,
"error": "Conflict",
"message": "Repository already connected.",
"data": {
"code": "repository_already_connected"
}
}Authorizations
Send your API token as Authorization: Bearer <api-token>.
Path Parameters
The app's ID (_id).
24-character hexadecimal ID.
Pattern:
^[0-9a-fA-F]{24}$The git provider.
Available options:
github Query Parameters
Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.
Pattern:
^[0-9a-fA-F]{24}$Body
application/json
Response
The repository was linked. The response body is empty.
⌘I
