Register a code host app
curl --request PUT \
--url https://api.example.com/api/code-hosts/apps/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "",
"client_secret": "<string>",
"base_url": "<string>",
"directory": "<string>"
}
'import requests
url = "https://api.example.com/api/code-hosts/apps/{provider}"
payload = {
"client_id": "",
"client_secret": "<string>",
"base_url": "<string>",
"directory": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '',
client_secret: '<string>',
base_url: '<string>',
directory: '<string>'
})
};
fetch('https://api.example.com/api/code-hosts/apps/{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.example.com/api/code-hosts/apps/{provider}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '',
'client_secret' => '<string>',
'base_url' => '<string>',
'directory' => '<string>'
]),
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.example.com/api/code-hosts/apps/{provider}"
payload := strings.NewReader("{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/code-hosts/apps/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/code-hosts/apps/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"provider": "<string>",
"label": "<string>",
"registered": true,
"client_id": "",
"secret_set": false,
"base_url": "",
"directory": "",
"self_hosted": false,
"supports_registration": false,
"console_url": "",
"setup_steps": [
"<string>"
],
"redirect_uri": "",
"connected_people": 0,
"registered_by": ""
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Code hosts
Register a code host app
Register or update a provider’s OAuth app.
An empty secret keeps the stored one. Changing the client ID or the directory drops everyone’s sign-ins, because their tokens belong to the old app.
PUT
/
api
/
code-hosts
/
apps
/
{provider}
Register a code host app
curl --request PUT \
--url https://api.example.com/api/code-hosts/apps/{provider} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "",
"client_secret": "<string>",
"base_url": "<string>",
"directory": "<string>"
}
'import requests
url = "https://api.example.com/api/code-hosts/apps/{provider}"
payload = {
"client_id": "",
"client_secret": "<string>",
"base_url": "<string>",
"directory": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '',
client_secret: '<string>',
base_url: '<string>',
directory: '<string>'
})
};
fetch('https://api.example.com/api/code-hosts/apps/{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.example.com/api/code-hosts/apps/{provider}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '',
'client_secret' => '<string>',
'base_url' => '<string>',
'directory' => '<string>'
]),
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.example.com/api/code-hosts/apps/{provider}"
payload := strings.NewReader("{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/code-hosts/apps/{provider}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/code-hosts/apps/{provider}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"\",\n \"client_secret\": \"<string>\",\n \"base_url\": \"<string>\",\n \"directory\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"provider": "<string>",
"label": "<string>",
"registered": true,
"client_id": "",
"secret_set": false,
"base_url": "",
"directory": "",
"self_hosted": false,
"supports_registration": false,
"console_url": "",
"setup_steps": [
"<string>"
],
"redirect_uri": "",
"connected_people": 0,
"registered_by": ""
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Authorizations
OAuth2AuthorizationCodeBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
github, gitlab, azure_devops, bitbucket
Body
application/json
Register a provider's OAuth app.
Maximum string length:
256Write-only. Empty keeps the stored one.
Maximum string length:
512A self-hosted host's base URL.
Maximum string length:
512Azure DevOps' Entra directory.
Maximum string length:
128Response
Successful Response
A provider and whether its app is set up. Never its secret.
Was this page helpful?

