Cloud Build API

Creates and manages builds on Google Cloud Platform.

Service: cloudbuild.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudbuild.googleapis.com

REST Resource: v1alpha1.projects.workerPools

Methods
create POST /v1alpha1/{parent=projects/*}/workerPools
Creates a WorkerPool to run the builds, and returns the new worker pool.
delete DELETE /v1alpha1/{name=projects/*/workerPools/*}
Deletes a WorkerPool by its project ID and WorkerPool name.
get GET /v1alpha1/{name=projects/*/workerPools/*}
Returns information about a WorkerPool.
list GET /v1alpha1/{parent=projects/*}/workerPools
List project's WorkerPools.
patch PATCH /v1alpha1/{name=projects/*/workerPools/*}
Update a WorkerPool.

Service: cloudbuild.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudbuild.googleapis.com

REST Resource: v1.operations

Methods
cancel POST /v1/{name=operations/**}:cancel
Starts asynchronous cancellation on a long-running operation.
get GET /v1/{name=operations/**}
Gets the latest state of a long-running operation.
list GET /v1/{name}
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.builds

Methods
cancel POST /v1/projects/{projectId}/builds/{id}:cancel
Cancels a build in progress.
create POST /v1/projects/{projectId}/builds
Starts a build with the specified configuration.
get GET /v1/projects/{projectId}/builds/{id}
Returns information about a previously requested build.
list GET /v1/projects/{projectId}/builds
Lists previously requested builds.
retry POST /v1/projects/{projectId}/builds/{id}:retry
Creates a new build based on the specified build.

REST Resource: v1.projects.triggers

Methods
create POST /v1/projects/{projectId}/triggers
Creates a new BuildTrigger.
delete DELETE /v1/projects/{projectId}/triggers/{triggerId}
Deletes a BuildTrigger by its project ID and trigger ID.
get GET /v1/projects/{projectId}/triggers/{triggerId}
Returns information about a BuildTrigger.
list GET /v1/projects/{projectId}/triggers
Lists existing BuildTriggers.
patch PATCH /v1/projects/{projectId}/triggers/{triggerId}
Updates a BuildTrigger by its project ID and trigger ID.
run POST /v1/projects/{projectId}/triggers/{triggerId}:run
Runs a BuildTrigger at a particular source revision.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Build Documentation