Skip to content

The GitHub service documentation.

These fields appear when creating or editing this connection. Required vs optional depends on the authentication options you enable.

FieldTypeDescription
NameTextDisplay name for this connection.
AliasText (multi-line)Optional alias or notes about the connection.
Is activeToggleWhether the connection is enabled. Disable to pause without deleting.
Db read onlyToggleRestrict the connection to read-only operations.
Access typeSelectRead-only, write-only, or read-write access level for this connection.
FieldTypeDescription
Use ssoToggleAuthenticate via single sign-on instead of username/password.
FieldTypeDescription
Use sslToggleEncrypt the connection with SSL/TLS.
Ssl modeSelectSSL verification mode (e.g., disable, require, verify-ca, verify-full).
Ssl auth client certText (multi-line)Client certificate (PEM) for mutual TLS authentication.
Ssl auth client keyText (multi-line)Client private key (PEM) for mutual TLS authentication.
Ssl auth root certText (multi-line)Root CA certificate (PEM) for verifying the server’s cert.
Ssl auth cert revokeText (multi-line)Certificate revocation list, if your environment uses one.
FieldTypeDescription
Use sshToggleTunnel the connection through an SSH bastion.
Ssh hostTextSSH bastion hostname.
Ssh portNumberSSH bastion port (default 22).
Ssh userTextSSH bastion username.
Ssh passwordPasswordSSH bastion password (if password auth is used).
Use ssh certToggleAuthenticate to the SSH bastion with a private key instead of password.
Ssh private keyText (multi-line)SSH private key (PEM) for bastion authentication.
Ssh host keyText (multi-line)Expected SSH host key for bastion fingerprint verification.
FieldTypeDescription
Repo pathText
Default branchText
Start pathText
Service usernameText
TokenPassword