Google

Cloud Deploy API

Cloud Deploy API endpoints from Google

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

Cloud Deploy API endpoints from Google

Endpoints 32

projects.locations.targets

  • GETGets details of a single Target./v1/:nameGets details of a single Target.
  • DELETEDeletes a single Target./v1/:name?allowMissing=true&etag=string&requestId=string&validateOnly=trueDeletes a single Target.
  • PATCHUpdates the parameters of a single Target./v1/:name?allowMissing=true&requestId=string&updateMask=string&validateOnly=trueUpdates the parameters of a single Target.
  • GETGets the access control policy for a resource/v1/: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.
  • POSTSets the access control policy on the specified resource/v1/: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/v1/: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…
  • GETLists Targets in a given project and location./v1/:parent/targets?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Targets in a given project and location.
  • POSTCreates a new Target in a given project and location./v1/:parent/targets?requestId=string&targetId=string&validateOnly=trueCreates a new Target in a given project and location.

projects.locations

  • GETLists information about the supported locations for this service/v1/: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…

projects.locations.customTargetTypes

  • GETLists CustomTargetTypes in a given project and location./v1/:parent/customTargetTypes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CustomTargetTypes in a given project and location.
  • POSTCreates a new CustomTargetType in a given project and location./v1/:parent/customTargetTypes?customTargetTypeId=string&requestId=string&validateOnly=trueCreates a new CustomTargetType in a given project and location.

projects.locations.deliveryPipelines

  • GETLists DeliveryPipelines in a given project and location./v1/:parent/deliveryPipelines?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DeliveryPipelines in a given project and location.
  • POSTCreates a new DeliveryPipeline in a given project and location./v1/:parent/deliveryPipelines?deliveryPipelineId=string&requestId=string&validateOnly=trueCreates a new DeliveryPipeline in a given project and location.
  • POSTCreates a `Rollout` to roll back the specified target./v1/:name:rollbackTargetCreates a Rollout to roll back the specified target.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/: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…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.deliveryPipelines.automationRuns

  • GETLists AutomationRuns in a given project and location./v1/:parent/automationRuns?filter=string&orderBy=string&pageSize=0&pageToken=stringLists AutomationRuns in a given project and location.

projects.locations.deliveryPipelines.automations

  • GETLists Automations in a given project and location./v1/:parent/automations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Automations in a given project and location.
  • POSTCreates a new Automation in a given project and location./v1/:parent/automations?automationId=string&requestId=string&validateOnly=trueCreates a new Automation in a given project and location.

projects.locations.deliveryPipelines.releases

  • POSTAbandons a Release in the Delivery Pipeline./v1/:name:abandonAbandons a Release in the Delivery Pipeline.
  • GETLists Releases in a given project and location./v1/:parent/releases?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Releases in a given project and location.
  • POSTCreates a new Release in a given project and location./v1/:parent/releases?overrideDeployPolicy=string&releaseId=string&requestId=string&validateOnly=trueCreates a new Release in a given project and location.

projects.locations.deliveryPipelines.releases.rollouts

  • POSTAdvances a Rollout in a given project and location./v1/:name:advanceAdvances a Rollout in a given project and location.
  • POSTApproves a Rollout./v1/:name:approveApproves a Rollout.
  • GETLists Rollouts in a given project and location./v1/:parent/rollouts?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Rollouts in a given project and location.
  • POSTCreates a new Rollout in a given project and location./v1/:parent/rollouts?overrideDeployPolicy=string&requestId=string&rolloutId=string&startingPhaseId=string&validateOnly=trueCreates a new Rollout in a given project and location.
  • POSTIgnores the specified Job in a Rollout./v1/:rollout:ignoreJobIgnores the specified Job in a Rollout.
  • POSTRetries the specified Job in a Rollout./v1/:rollout:retryJobRetries the specified Job in a Rollout.

projects.locations.deliveryPipelines.releases.rollouts.jobRuns

  • GETLists JobRuns in a given project and location./v1/:parent/jobRuns?filter=string&orderBy=string&pageSize=0&pageToken=stringLists JobRuns in a given project and location.
  • POSTTerminates a Job Run in a given project and location./v1/:name:terminateTerminates a Job Run in a given project and location.

projects.locations.deployPolicies

  • GETLists DeployPolicies in a given project and location./v1/:parent/deployPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DeployPolicies in a given project and location.
  • POSTCreates a new DeployPolicy in a given project and location./v1/:parent/deployPolicies?deployPolicyId=string&requestId=string&validateOnly=trueCreates a new DeployPolicy in a given project and location.

API details

Base URL
https://clouddeploy.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
32 operations on 23 pathsPOST 17GET 13PATCH 1DELETE 1
Main resources
projects.locations.targets 8projects.locations.deliveryPipelines.releases.rollouts 6projects.locations.deliveryPipelines 3projects.locations.deliveryPipelines.releases 3projects.locations.customTargetTypes 2projects.locations.deliveryPipelines.automations 2projects.locations.deliveryPipelines.releases.rollouts.jobR… 2projects.locations.deployPolicies 2projects.locations.operations 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Deploy 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 Deploy 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 details of a single Target.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Deploy API?

Cloud Deploy API endpoints from Google It is listed under Developer tools and has 32 endpoints.

Who publishes the Cloud Deploy 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 Deploy API?

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

How do I authenticate with the Cloud Deploy 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 Deploy API have?

32 operations on 23 paths (17 POST, 13 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.targets, projects.locations.deliveryPipelines.releases.rollouts, projects.locations.deliveryPipelines, projects.locations.deliveryPipelines.releases.

Is forking the Cloud Deploy 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.