Skip to main content
POST
/
api
/
v1
/
app-connections
/
github
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/github \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "github-app",
  "credentials": {
    "code": "<string>",
    "installationId": "<string>",
    "instanceType": "server",
    "host": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "isPlatformManagedCredentials": false,
  "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "appConnection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "app": "github",
    "method": "github-app",
    "credentials": {
      "instanceType": "server",
      "host": "<string>"
    },
    "description": "<string>",
    "version": 1,
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "credentialsHash": "<string>",
    "project": {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>",
      "slug": "<string>"
    }
  }
}
GitHub Connections must be created through the Infisical UI. Check out the configuration docs for GitHub Connections for a step-by-step guide.

Body

application/json
  • Option 1
  • Option 2
  • Option 3
​
method
enum<string>
required

The method used to authenticate with GitHub.

Available options:
github-app
​
credentials
object
required

The credentials used to connect with GitHub.

  • Option 1
  • Option 2
​
name
string
required

The name of the GitHub Connection to create. Must be slug-friendly.

Required string length: 1 - 64
​
description
string | null

An optional description for the GitHub Connection.

Maximum string length: 256
​
projectId
string

The ID of the project to create the GitHub Connection in.

​
isPlatformManagedCredentials
enum<boolean>

Not supported for GitHub Connections.

Available options:
true,
false
​
gatewayId
string<uuid> | null

The Gateway ID to use for this connection.

Response

Default Response

​
appConnection
GitHub (GitHub App) · object
required
  • GitHub (GitHub App)
  • GitHub (OAuth)
  • GitHub (Personal Access Token)