Google

Cloud Build API

Creates and manages builds on Google Cloud Platform.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Creates and manages builds on Google Cloud Platform.

Endpoints 18

projects.locations.operations

  • GETGets the latest state of a long-running operation/v2/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • POSTStarts asynchronous cancellation on a long-running operation/v2/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…

projects.locations.connections.repositories

  • DELETEDeletes a single repository./v2/:name?etag=string&validateOnly=trueDeletes a single repository.
  • POSTFetches read token of a given repository./v2/:repository:accessReadTokenFetches read token of a given repository.
  • POSTFetches read/write token of a given repository./v2/:repository:accessReadWriteTokenFetches read/write token of a given repository.
  • POSTCreates multiple repositories inside a connection./v2/:parent/repositories:batchCreateCreates multiple repositories inside a connection.
  • GETLists Repositories in a given connection./v2/:parent/repositories?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists Repositories in a given connection.
  • POSTCreates a Repository./v2/:parent/repositories?repositoryId=stringCreates a Repository.
  • GETFetch the list of branches or tags for a given repository./v2/:repository:fetchGitRefs?pageSize=0&pageToken=string&refType=REF_TYPE_UNSPECIFIEDFetch the list of branches or tags for a given repository.

projects.locations.connections

  • PATCHUpdates a single connection./v2/:name?allowMissing=true&etag=string&updateMask=stringUpdates a single connection.
  • GETLists Connections in a given project and location./v2/:parent/connections?pageSize=0&pageToken=string&returnPartialSuccess=trueLists Connections in a given project and location.
  • POSTCreates a Connection./v2/:parent/connections?connectionId=stringCreates a Connection.
  • GETFetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection./v2/:connection:fetchLinkableRepositories?pageSize=0&pageToken=stringFetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.
  • GETGets the access control policy for a resource/v2/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTProcessWebhook is called by the external SCM for notifying of events./v2/:parent/connections:processWebhook?webhookKey=stringProcessWebhook is called by the external SCM for notifying of events.
  • POSTSets the access control policy on the specified resource/v2/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v2/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…

projects.locations

  • GETLists information about the supported locations for this service/v2/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

API details

Base URL
https://cloudbuild.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
18 operations on 14 pathsPOST 9GET 7PATCH 1DELETE 1
Main resources
projects.locations.connections 8projects.locations.connections.repositories 7projects.locations.operations 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v2

How to test the Cloud Build API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Build API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v2/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Build API?

Creates and manages builds on Google Cloud Platform. It is listed under Developer tools and has 18 endpoints.

Who publishes the Cloud Build API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Build API?

Requests go to https://cloudbuild.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Build API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Cloud Build API have?

18 operations on 14 paths (9 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.connections, projects.locations.connections.repositories, projects.locations.operations, projects.locations.

Is forking the Cloud Build API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.