Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xata GitHub App API

Operations for managing GitHub App installation mappings

Xata GitHub App API is one of 12 APIs that Xata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GitHub App. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.xata.tech.

7 operations 3 paths 7 schemas 1 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.xata.tech
Authentication
OpenID Connect, API Key, OAuth 2.0, API Key
Contact
help@xata.io
Resource Areas
1

Authentication & Security 4

Xata GitHub App API declares 4 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.xata.io/realms/xata/.well-known/openid-configuration. An API key is passed in the header as Authorization (apiKey). It supports OAuth 2.0 (xata) using the implicit flow, exposing 13 scopes. An API key is passed in the header as Connection-String (branchConnectionString).

  • apiKey — API key authentication using Bearer token format: Bearer
  • branchConnectionString — Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

GitHub App 7

Operations for managing GitHub App installation mappings

GET
/organizations/{organizationID}/githubapp/installations
List GitHub App installations for organization
listGithubAppInstallations 1 param → 2004004015XXdefault
POST
/organizations/{organizationID}/githubapp/installations
Create GitHub App installation
createGithubAppInstallation 1 param body → 2014004014095XXdefault
PUT
/organizations/{organizationID}/githubapp/installations/{githubInstallationID}
Update GitHub App installation
updateGithubAppInstallation 2 params body → 2004004014044095XXdefault
GET
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/githubapp/repository
Get GitHub repository for branch
getGithubRepository 3 params → 2004004015XXdefault
POST
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/githubapp/repository
Create GitHub repository mapping
createGithubRepository 3 params body → 2014004014095XXdefault
PUT
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/githubapp/repository
Update GitHub repository mapping
updateGithubRepository 3 params body → 2004004014045XXdefault
DELETE
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/githubapp/repository
Delete GitHub repository mapping
deleteGithubRepository 3 params → 2044004014045XXdefault

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GithubRepository (6 properties), GithubInstallation (5 properties), CreateGithubRepositoryRequest (1 property), UpdateGithubAppInstallationRequest (1 property). Each schema is shown below with its type and property counts.

UpdateGithubRepositoryRequest
object
1 property 1 required
OrganizationID
string
CreateGithubAppInstallationRequest
object
1 property 1 required
UpdateGithubAppInstallationRequest
object
1 property 1 required
GithubRepository
object
A mapping between a GitHub repository and a Xata project
6 properties 6 required
CreateGithubRepositoryRequest
object
1 property 1 required
GithubInstallation
object
A GitHub App installation associated with an organization
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-github-app-api-openapi.yml Raw ↑

Other APIs Xata publishes across the network.

Xata API Keys API
Xata Billing API
Xata Branches API
Xata Gateway API
Xata Logs API
Xata Marketplace API
Xata Metrics API
Xata Organizations API
Xata Projects API
Xata Projects Webhooks API
Xata Webhooks API