REST Resource: projects.githubEnterpriseConfigs

Resource: GitHubEnterpriseConfig

GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

JSON representation 
{
  "name": string,
  "hostUrl": string,
  "appId": string,
  "createTime": string,
  "webhookKey": string,
  "peeredNetwork": string,
  "secrets": {
    object (GitHubEnterpriseSecrets)
  },
  "displayName": string,
  "sslCa": string
}
Fields
name

string

The full resource name for the GitHubEnterpriseConfig For example: "projects/{$projectId}/locations/{$locationId}/githubEnterpriseConfigs/{$configId}"
hostUrl

string

The URL of the github enterprise host the configuration is for.
appId

string (int64 format)

Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
createTime

string (Timestamp format)

Output only. Time when the installation was associated with the project.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
webhookKey

string

The key that should be attached to webhook calls to the v1.webhook endpoint.
peeredNetwork

string

Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secrets

object (GitHubEnterpriseSecrets)

Optional. Names of secrets in Secret Manager.
displayName

string

Optional. Name to display for this config.
sslCa

string

Optional. SSL certificate to use for requests to GitHub Enterprise.

GitHubEnterpriseSecrets

GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/.

JSON representation 
{
  "privateKeyName": string,
  "webhookSecretName": string,
  "oauthSecretName": string,
  "oauthClientIdName": string,
  "privateKeyVersionName": string,
  "webhookSecretVersionName": string,
  "oauthSecretVersionName": string,
  "oauthClientIdVersionName": string
}
Fields
privateKeyName
(deprecated)

string

The resource name for the private key secret.
webhookSecretName
(deprecated)

string

The resource name for the webhook secret in Secret Manager.
oauthSecretName
(deprecated)

string

The resource name for the OAuth secret in Secret Manager.
oauthClientIdName
(deprecated)

string

The resource name for the OAuth client ID secret in Secret Manager.
privateKeyVersionName

string

The resource name for the private key secret version.
webhookSecretVersionName

string

The resource name for the webhook secret secret version in Secret Manager.
oauthSecretVersionName

string

The resource name for the OAuth secret secret version in Secret Manager.
oauthClientIdVersionName

string

The resource name for the OAuth client ID secret version in Secret Manager.

Methods

create

 Create an association between a GCP project and a GitHub Enterprise server.

delete

 Delete an association between a GCP project and a GitHub Enterprise server.

get

 Retrieve a GitHubEnterpriseConfig.

list

 List all GitHubEnterpriseConfigs for a given project.

patch

 Update an association between a GCP project and a GitHub Enterprise server.