Cloud TPU API
TPU API provides customers with access to Google TPU technology.
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
TPU API provides customers with access to Google TPU technology.
Endpoints 17
projects.locations
- POSTGenerates the Cloud TPU service identity for the project.
/v2/:parent:generateServiceIdentityGenerates the Cloud TPU service identity for the project. - GETLists information about the supported locations for this service
/v2/: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.runtimeVersions
- GETGets a runtime version.
/v2/:nameGets a runtime version. - GETLists runtime versions supported by this API.
/v2/:parent/runtimeVersions?filter=string&orderBy=string&pageSize=0&pageToken=stringLists runtime versions supported by this API.
projects.locations.queuedResources
- DELETEDeletes a QueuedResource TPU instance.
/v2/:name?force=true&requestId=stringDeletes a QueuedResource TPU instance. - GETLists queued resources.
/v2/:parent/queuedResources?pageSize=0&pageToken=stringLists queued resources. - POSTCreates a QueuedResource TPU instance.
/v2/:parent/queuedResources?queuedResourceId=string&requestId=stringCreates a QueuedResource TPU instance. - POSTResets a QueuedResource TPU instance
/v2/:name:resetResets a QueuedResource TPU instance
projects.locations.nodes
- PATCHUpdates the configurations of a node.
/v2/:name?updateMask=stringUpdates the configurations of a node. - GETLists nodes.
/v2/:parent/nodes?pageSize=0&pageToken=stringLists nodes. - POSTCreates a node.
/v2/:parent/nodes?nodeId=stringCreates a node. - POSTRetrieves the guest attributes for the node.
/v2/:name:getGuestAttributesRetrieves the guest attributes for the node. - POSTStarts a node.
/v2/:name:startStarts a node. - POSTStops a node
/v2/:name:stopStops a node. This operation is only available with single TPU nodes.
projects.locations.acceleratorTypes
- GETLists accelerator types supported by this API.
/v2/:parent/acceleratorTypes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists accelerator types supported by this API.
projects.locations.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v2/: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
/v2/: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://tpu.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 17 operations on 13 pathsPOST 8GET 7PATCH 1DELETE 1
- Main resources
- projects.locations.nodes 6projects.locations.queuedResources 4projects.locations 2projects.locations.operations 2projects.locations.runtimeVersions 2projects.locations.acceleratorTypes 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud TPU 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 Cloud TPU 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 “Generates the Cloud TPU service identity for the project.” (POST /v2/:parent:generateServiceIdentity), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud TPU API?
TPU API provides customers with access to Google TPU technology. It is listed under Developer tools and has 17 endpoints.
Who publishes the Cloud TPU 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 Cloud TPU API?
Requests go to https://tpu.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud TPU 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 Cloud TPU API have?
17 operations on 13 paths (8 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.nodes, projects.locations.queuedResources, projects.locations, projects.locations.operations.
Is forking the Cloud TPU API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.