Skip to main content
POST
Start registration of a customer-owned GitHub App

Authorizations

__Host-omnara_session
string
cookie
required

Browser session cookie. HTTPS deployments use __Host-omnara_session; local HTTP development uses omnara_session.

X-Omnara-Csrf
string
header
required

CSRF token header required for browser-session mutations. The value must match the session's CSRF cookie.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$
projectID
string
required
Pattern: ^proj_[a-z2-7]{26}$
integrationID
string
required
Pattern: ^itg_[a-z2-7]{26}$

Body

application/json
expected_setup_revision
integer
required
Required range: x >= 1
app_name
string

Optional initial GitHub App name suggestion. When omitted, the user chooses a name on GitHub during registration.

Required string length: 1 - 34
organization
string

GitHub organization login. Omit to register under a personal account.

Required string length: 1 - 39
Pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

Response

GitHub setup information verified.

integration_id
string
required
Pattern: ^itg_[a-z2-7]{26}$
setup_revision
integer
required
Required range: x >= 1
registration_url
string<uri>
required
manifest
object
required

Server-authored GitHub App manifest. Serialize this object to the manifest form field when posting to registration_url.

expires_at
string<date-time>
required