Cloud Build API

Creates and manages builds on Google Cloud Platform.

Service: cloudbuild.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make 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 document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might 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.

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.locations.builds

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

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.

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.