Google

Workflows API

Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.

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

Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.

Endpoints 8

projects.locations.workflows

  • GETGets details of a single workflow./v1/:name?revisionId=stringGets details of a single workflow.
  • DELETEDeletes a workflow with the specified name/v1/:nameDeletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
  • PATCHUpdates an existing workflow/v1/:name?updateMask=stringUpdates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created…
  • GETLists workflows in a given project and location/v1/:parent/workflows?filter=string&orderBy=string&pageSize=0&pageToken=stringLists workflows in a given project and location. The default order is not specified.
  • POSTCreates a new workflow/v1/:parent/workflows?workflowId=stringCreates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a…
  • GETLists revisions for a given workflow./v1/:name:listRevisions?pageSize=0&pageToken=stringLists revisions for a given workflow.

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

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

API details

Base URL
https://workflows.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
8 operations on 5 pathsGET 5POST 1PATCH 1DELETE 1
Main resources
projects.locations.workflows 6projects.locations 1projects.locations.operations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Workflows 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 Workflows 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 workflow.” (GET /v1/:name?revisionId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Workflows API?

Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API. It is listed under Developer tools and has 8 endpoints.

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

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

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

8 operations on 5 paths (5 GET, 1 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.workflows, projects.locations, projects.locations.operations.

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