Data pipelines API
Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs.
Data & analytics#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
Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs.
Endpoints 8
projects.locations.pipelines
- GETLists pipelines
/v1/:parent/pipelines?filter=string&pageSize=0&pageToken=stringLists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. - POSTCreates a pipeline
/v1/:parent/pipelinesCreates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler… - GETLooks up a single pipeline
/v1/:nameLooks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to… - DELETEDeletes a pipeline
/v1/:nameDeletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. - PATCHUpdates a pipeline
/v1/:name?updateMask=stringUpdates a pipeline. If successful, the updated Pipeline is returned. Returns NOT_FOUND if the pipeline doesn't exist. If UpdatePipeline does not return… - POSTCreates a job for the specified pipeline directly
/v1/:name:runCreates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job… - POSTFreezes pipeline execution permanently
/v1/:name:stopFreezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However,…
projects.locations.pipelines.jobs
- GETLists jobs for a given pipeline
/v1/:parent/jobs?pageSize=0&pageToken=stringLists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.
API details
- Base URL
https://datapipelines.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 3POST 3PATCH 1DELETE 1
- Main resources
- projects.locations.pipelines 7projects.locations.pipelines.jobs 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Data pipelines API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Data pipelines API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Lists pipelines” (GET /v1/:parent/pipelines?filter=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Data pipelines API?
Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs. It is listed under Data & analytics and has 8 endpoints.
Who publishes the Data pipelines 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 Data pipelines API?
Requests go to https://datapipelines.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Data pipelines 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 Data pipelines API have?
8 operations on 5 paths (3 GET, 3 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.pipelines, projects.locations.pipelines.jobs.
Is forking the Data pipelines API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.