Google

Notebooks API

Notebooks API is used to manage notebook resources in Google Cloud.

AI & machine learning#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

Notebooks API is used to manage notebook resources in Google Cloud.

Endpoints 25

projects.locations.operations

  • GETGets the latest state of a long-running operation/v2/: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/v2/: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/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.

projects.locations.instances

  • PATCHUpdateInstance updates an Instance./v2/:name?requestId=string&updateMask=stringUpdateInstance updates an Instance.
  • POSTInitiated by Cloud Console for Oauth consent flow for Workbench Instances/v2/:name:checkAuthorizationInitiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method directly. Design doc: go/wbi-euc:auth-dd
  • GETChecks whether a notebook instance is upgradable./v2/:notebookInstance:checkUpgradabilityChecks whether a notebook instance is upgradable.
  • GETLists instances in a given project and location./v2/:parent/instances?filter=string&orderBy=string&pageSize=0&pageToken=stringLists instances in a given project and location.
  • POSTCreates a new Instance in a given project and location./v2/:parent/instances?instanceId=string&requestId=stringCreates a new Instance in a given project and location.
  • POSTCreates a Diagnostic File and runs Diagnostic Tool given an Instance./v2/:name:diagnoseCreates a Diagnostic File and runs Diagnostic Tool given an Instance.
  • POSTCalled by VM to return an EUC for the instance owner/v2/:name:generateAccessTokenCalled by VM to return an EUC for the instance owner. Do not use this method directly. Design doc: go/wbi-euc:dd
  • GETReturns various configuration parameters./v2/:name/instances:getConfigReturns various configuration parameters.
  • GETGets the access control policy for a resource/v2/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTAllows notebook instances to report their latest instance information to the Notebooks API server/v2/:name:reportInfoSystemAllows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the…
  • POSTResets a notebook instance./v2/:name:resetResets a notebook instance.
  • POSTResize a notebook instance disk to a higher capacity./v2/:notebookInstance:resizeDiskResize a notebook instance disk to a higher capacity.
  • POSTRestoreInstance restores an Instance from a BackupSource./v2/:name:restoreRestoreInstance restores an Instance from a BackupSource.
  • POSTRollbacks a notebook instance to the previous version./v2/:name:rollbackRollbacks a notebook instance to the previous version.
  • POSTSets the access control policy on the specified resource/v2/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTStarts a notebook instance./v2/:name:startStarts a notebook instance.
  • POSTStops a notebook instance./v2/:name:stopStops a notebook instance.
  • POSTReturns permissions that a caller has on the specified resource/v2/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
  • POSTUpgrades a notebook instance to the latest version./v2/:name:upgradeUpgrades a notebook instance to the latest version.
  • POSTAllows notebook instances to upgrade themselves/v2/:name:upgradeSystemAllows notebook instances to upgrade themselves. Do not use this method directly.

projects.locations

  • 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…

API details

Base URL
https://notebooks.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
25 operations on 22 pathsPOST 16GET 7PATCH 1DELETE 1
Main resources
projects.locations.instances 20projects.locations.operations 4projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v2

How to test the Notebooks API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Notebooks API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v2/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Notebooks API?

Notebooks API is used to manage notebook resources in Google Cloud. It is listed under AI & machine learning and has 25 endpoints.

Who publishes the Notebooks 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 Notebooks API?

Requests go to https://notebooks.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Notebooks API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Notebooks API have?

25 operations on 22 paths (16 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.instances, projects.locations.operations, projects.locations.

Is forking the Notebooks API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.