REST Resource: projects.locations.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

Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$projectId}/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)

Names of secrets in Secret Manager.

displayName

string

Name to display for this config.

sslCa

string

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

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.