Sign in
gitpod.v1.RunnerConfigurationService

CreateSCMIntegration

Creates a new SCM integration for a runner.

Use this method to:

  • Configure source control access
  • Set up repository integrations
  • Enable code synchronization

Examples

  • Create GitHub integration:

    Sets up GitHub SCM integration.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmId: "github"
host: "github.com"
oauthClientId: "client_id"
oauthPlaintextClientSecret: "client_secret"
post/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration

Request body

hoststring
oauthClientIdstring nullable

oauth_client_id is the OAuth app's client ID, if OAuth is configured. If configured, oauth_plaintext_client_secret must also be set.

oauthPlaintextClientSecretstring nullable

oauth_plaintext_client_secret is the OAuth app's client secret in clear text. This will first be encrypted with the runner's public key before being stored.

patboolean
runnerIdstring uuid
scmIdstring

scm_id references the scm_id in the runner's configuration schema that this integration is for

Response

Success

idstring uuid

id is a uniquely generated identifier for the SCM integration

Changes