Batch API
An API to manage the running of Batch resources on Google Cloud Platform.
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
An API to manage the running of Batch resources on Google Cloud Platform.
Endpoints 9
projects.locations.operations
- GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - 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
- 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.jobs
- GETList all Jobs for a project within a region.
/v1/:parent/jobs?filter=string&orderBy=string&pageSize=0&pageToken=stringList all Jobs for a project within a region. - POSTCreate a Job.
/v1/:parent/jobs?jobId=string&requestId=stringCreate a Job.
projects.locations.jobs.taskGroups.tasks
- GETList Tasks associated with a job.
/v1/:parent/tasks?filter=string&pageSize=0&pageToken=stringList Tasks associated with a job.
projects.locations.state
- POSTReport agent's state, e.g
/v1/:parent/state:reportReport agent's state, e.g. agent status and tasks information
API details
- Base URL
https://batch.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 9 operations on 7 pathsGET 5POST 3DELETE 1
- Main resources
- projects.locations.operations 4projects.locations.jobs 2projects.locations 1projects.locations.jobs.taskGroups.tasks 1projects.locations.state 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 Batch 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 Batch 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 “Gets the latest state of a long-running operation” (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 Batch API?
An API to manage the running of Batch resources on Google Cloud Platform. It is listed under Developer tools and has 9 endpoints.
Who publishes the Batch 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 Batch API?
Requests go to https://batch.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Batch 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 Batch API have?
9 operations on 7 paths (5 GET, 3 POST, 1 DELETE). The largest groups are projects.locations.operations, projects.locations.jobs, projects.locations, projects.locations.jobs.taskGroups.tasks.
Is forking the Batch API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.