Skip to content
OpenParablePublic APIs

Dataflow API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Manages Google Cloud Dataflow projects on Google Cloud Platform.

Dataflow API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 41 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://dataflow.googleapis.com/
Version
v1b3
Endpoints
41
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://dataflow.googleapis.com/v1b3/projects/PROJECTID/jobs" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://dataflow.googleapis.com/v1b3/projects/PROJECTID/jobs", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://dataflow.googleapis.com/v1b3/projects/PROJECTID/jobs",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1b3/projects/{projectId}/WorkerMessagesSend a worker_message to the service.
GET/v1b3/projects/{projectId}/jobsList the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://clo
POST/v1b3/projects/{projectId}/jobsCreates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow
GET/v1b3/projects/{projectId}/jobs/{jobId}Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (http
PUT/v1b3/projects/{projectId}/jobs/{jobId}Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regiona
POST/v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfigGet encoded debug configuration for component. Not cacheable.
POST/v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCaptureSend encoded debug capture data for component.
GET/v1b3/projects/{projectId}/jobs/{jobId}/messagesRequest the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.goo
GET/v1b3/projects/{projectId}/jobs/{jobId}/metricsRequest the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google
POST/v1b3/projects/{projectId}/jobs/{jobId}/workItems:leaseLeases a dataflow WorkItem to run.
POST/v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatusReports the status of dataflow WorkItems leased by a worker.
POST/v1b3/projects/{projectId}/jobs/{jobId}:snapshotSnapshot the state of a streaming job.
GET/v1b3/projects/{projectId}/jobs:aggregatedList the jobs of a project across all regions.
POST/v1b3/projects/{projectId}/locations/{location}/WorkerMessagesSend a worker_message to the service.
POST/v1b3/projects/{projectId}/locations/{location}/flexTemplates:launchLaunch a job with a FlexTemplate.
GET/v1b3/projects/{projectId}/locations/{location}/jobsList the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://clo
POST/v1b3/projects/{projectId}/locations/{location}/jobsCreates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (http
PUT/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regiona
POST/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfigGet encoded debug configuration for component. Not cacheable.
POST/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCaptureSend encoded debug capture data for component.
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetailsRequest detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messagesRequest the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.goo
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metricsRequest the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshotsLists snapshots.
GET/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetailsRequest detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice.
POST/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:leaseLeases a dataflow WorkItem to run.
POST/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatusReports the status of dataflow WorkItems leased by a worker.
POST/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshotSnapshot the state of a streaming job.
GET/v1b3/projects/{projectId}/locations/{location}/snapshotsLists snapshots.
GET/v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}Gets information about a snapshot.
DELETE/v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}Deletes a snapshot.
POST/v1b3/projects/{projectId}/locations/{location}/templatesCreates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
GET/v1b3/projects/{projectId}/locations/{location}/templates:getGet the template associated with a template.
POST/v1b3/projects/{projectId}/locations/{location}/templates:launchLaunch a template.
GET/v1b3/projects/{projectId}/snapshotsLists snapshots.
DELETE/v1b3/projects/{projectId}/snapshotsDeletes a snapshot.
GET/v1b3/projects/{projectId}/snapshots/{snapshotId}Gets information about a snapshot.
POST/v1b3/projects/{projectId}/templatesCreates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
GET/v1b3/projects/{projectId}/templates:getGet the template associated with a template.
POST/v1b3/projects/{projectId}/templates:launchLaunch a template.

Questions

Does the Dataflow API API need an API key?

Yes. The Dataflow API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Dataflow API API support HTTPS?

Yes, the Dataflow API API is served over HTTPS.

How many endpoints does the Dataflow API API have?

Its OpenAPI description lists 41 endpoints in version v1b3. All of them are shown on this page.

What are alternatives to the Dataflow API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).