Skip to main content
POST
cURL
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
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.

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:
false
gatewayId
string<uuid> | null

The Gateway ID to use for this connection.

gatewayPoolId
string<uuid> | null

The Gateway Pool ID to use for this connection.

isAutoRotationEnabled
enum<boolean>

Not supported for GitHub Connections.

Available options:
false
rotation

Not supported for GitHub Connections.

Response

Default Response

appConnection
GitHub (GitHub App) · object
required