Method: projects.locations.instances.register

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

HTTP request


Path parameters



Required. Format: parent=projects/{projectId}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.instances.create

Request body

The request body contains data with the following structure:

JSON representation
  "instanceId": string


Required. User defined unique ID of this instance. The instanceId must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.