curl --request POST \
--url https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup \
--header 'Content-Type: application/json' \
--header 'X-BMA-Csrf: <api-key>' \
--cookie __Host-bma_session= \
--data '
{
"expected_setup_revision": 2,
"app_name": "<string>",
"organization": "<string>"
}
'import requests
url = "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup"
payload = {
"expected_setup_revision": 2,
"app_name": "<string>",
"organization": "<string>"
}
headers = {
"cookie": "__Host-bma_session=",
"X-BMA-Csrf": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
cookie: '__Host-bma_session=',
'X-BMA-Csrf': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expected_setup_revision: 2, app_name: '<string>', organization: '<string>'})
};
fetch('https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup"
payload := strings.NewReader("{\n \"expected_setup_revision\": 2,\n \"app_name\": \"<string>\",\n \"organization\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "__Host-bma_session=")
req.Header.Add("X-BMA-Csrf", "<api-key>")
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))
}{
"integration_id": "<string>",
"setup_revision": 2,
"registration_url": "<string>",
"manifest": {},
"expires_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Start registration of a customer-owned GitHub App
Starts guided registration on github.com for a never-connected GitHub integration. Requires a browser session and project management access. Submit manifest as a JSON-encoded form field to registration_url. The callback saves a project credential secret and redirects to the canonical integration page with github_setup=credentials_saved and credential_secret_id (a public secret ID). It does not connect an installation or change launcher settings.
curl --request POST \
--url https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup \
--header 'Content-Type: application/json' \
--header 'X-BMA-Csrf: <api-key>' \
--cookie __Host-bma_session= \
--data '
{
"expected_setup_revision": 2,
"app_name": "<string>",
"organization": "<string>"
}
'import requests
url = "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup"
payload = {
"expected_setup_revision": 2,
"app_name": "<string>",
"organization": "<string>"
}
headers = {
"cookie": "__Host-bma_session=",
"X-BMA-Csrf": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
cookie: '__Host-bma_session=',
'X-BMA-Csrf': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expected_setup_revision: 2, app_name: '<string>', organization: '<string>'})
};
fetch('https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.bma.beeos.ai/api/v1/orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup"
payload := strings.NewReader("{\n \"expected_setup_revision\": 2,\n \"app_name\": \"<string>\",\n \"organization\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "__Host-bma_session=")
req.Header.Add("X-BMA-Csrf", "<api-key>")
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))
}{
"integration_id": "<string>",
"setup_revision": 2,
"registration_url": "<string>",
"manifest": {},
"expires_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Browser session cookie. HTTPS deployments use __Host-bma_session; local HTTP development uses bma_session.
CSRF token header required for browser-session mutations. The value must match the session's CSRF cookie.
Path Parameters
Organization ID (org_...).
^org_[a-z2-7]{26}$Project ID (proj_...).
^proj_[a-z2-7]{26}$Integration ID (itg_...).
^itg_[a-z2-7]{26}$Body
x >= 1Optional initial GitHub App name suggestion. When omitted, the user chooses a name on GitHub during registration.
1 - 34GitHub organization login. Omit to register under a personal account.
1 - 39^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$Response
GitHub setup information verified.
^itg_[a-z2-7]{26}$x >= 1Server-authored GitHub App manifest. Serialize this object to the manifest form field when posting to registration_url.