REST Resource: projects.locations.bitbucketServerConfigs

Stay organized with collections Save and categorize content based on your preferences.

Resource: BitbucketServerConfig

BitbucketServerConfig represents the configuration for a Bitbucket Server.

JSON representation
{
  "name": string,
  "hostUri": string,
  "secrets": {
    object (BitbucketServerSecrets)
  },
  "createTime": string,
  "username": string,
  "webhookKey": string,
  "apiKey": string,
  "connectedRepositories": [
    {
      object (BitbucketServerRepositoryId)
    }
  ],
  "peeredNetwork": string,
  "sslCa": string
}
Fields
name

string

The resource name for the config.

hostUri

string

Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.

secrets

object (BitbucketServerSecrets)

Required. Secret Manager secrets needed by the config.

createTime

string (Timestamp format)

Time when the config was created.

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".

username

string

Username of the account Cloud Build will use on Bitbucket Server.

webhookKey

string

Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.

apiKey

string

Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.

connectedRepositories[]

object (BitbucketServerRepositoryId)

Output only. Connected Bitbucket Server repositories for this config.

peeredNetwork

string

Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance 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 Bitbucket Server instance 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.

sslCa

string

Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt.

BitbucketServerSecrets

BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server.

JSON representation
{
  "adminAccessTokenVersionName": string,
  "readAccessTokenVersionName": string,
  "webhookSecretVersionName": string
}
Fields
adminAccessTokenVersionName

string

Required. The resource name for the admin access token's secret version.

readAccessTokenVersionName

string

Required. The resource name for the read access token's secret version.

webhookSecretVersionName

string

Required. Immutable. The resource name for the webhook secret's secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.

BitbucketServerRepositoryId

BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.

JSON representation
{
  "projectKey": string,
  "repoSlug": string,
  "webhookId": integer
}
Fields
projectKey

string

Required. Identifier for the project storing the repository.

repoSlug

string

Required. Identifier for the repository.

webhookId

integer

Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.

Methods

create

Creates a new BitbucketServerConfig.

delete

Delete a BitbucketServerConfig.

get

Retrieve a BitbucketServerConfig.

list

List all BitbucketServerConfigs for a given project.

patch

Updates an existing BitbucketServerConfig.

removeBitbucketServerConnectedRepository

Remove a Bitbucket Server repository from a given BitbucketServerConfig's connected repositories.