Workflows API

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

Service: workflows.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 documents:

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://workflows.googleapis.com

REST Resource: v1beta.projects.locations

Methods
get GET /v1beta/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.projects.locations.operations

Methods
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1beta.projects.locations.workflows

Methods
create POST /v1beta/{parent=projects/*/locations/*}/workflows
Creates a new workflow.
delete DELETE /v1beta/{name=projects/*/locations/*/workflows/*}
Deletes a workflow with the specified name.
get GET /v1beta/{name=projects/*/locations/*/workflows/*}
Gets details of a single Workflow.
list GET /v1beta/{parent=projects/*/locations/*}/workflows
Lists Workflows in a given project and location.
patch PATCH /v1beta/{workflow.name=projects/*/locations/*/workflows/*}
Updates an existing workflow.

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.operations

Methods
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.workflows

Methods
create POST /v1/{parent=projects/*/locations/*}/workflows
Creates a new workflow.
delete DELETE /v1/{name=projects/*/locations/*/workflows/*}
Deletes a workflow with the specified name.
get GET /v1/{name=projects/*/locations/*/workflows/*}
Gets details of a single workflow.
list GET /v1/{parent=projects/*/locations/*}/workflows
Lists workflows in a given project and location.
listRevisions GET /v1/{name=projects/*/locations/*/workflows/*}:listRevisions
Lists revisions for a given workflow.
patch PATCH /v1/{workflow.name=projects/*/locations/*/workflows/*}
Updates an existing workflow.