CreateSCMIntegration

client.runners.configurations.scmIntegrations.create(, ?): ScmIntegrationCreateResponse { id }

POST/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"

ParametersExpand Collapse

body: ScmIntegrationCreateParams { host, issuerUrl, oauthClientId, 5 more }

host?: string

issuerUrl?: string | null

issuer_url can be set to override the authentication provider URL, if it doesn’t match the SCM host.

oauthClientId?: string | null

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

oauthPlaintextClientSecret?: string | null

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.

pat?: boolean

runnerId?: string

formatuuid

scmId?: string

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

virtualDirectory?: string | null

virtual_directory is the virtual directory path for Azure DevOps Server (e.g., “/tfs”). This field is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types. Azure DevOps Server APIs work without collection when PAT scope is ‘All accessible organizations’.

ReturnsExpand Collapse

ScmIntegrationCreateResponse { id }

id?: string

id is a uniquely generated identifier for the SCM integration

formatuuid

CreateSCMIntegration

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const scmIntegration = await client.runners.configurations.scmIntegrations.create({
  host: 'github.com',
  oauthClientId: 'client_id',
  oauthPlaintextClientSecret: 'client_secret',
  runnerId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
  scmId: 'github',
});

console.log(scmIntegration.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}