REST API resources
Colab Enterprise is a part of Vertex AI. You can interact with Colab Enterprise by using the Vertex AI API.
This page describes important REST resources for using Colab Enterprise through the API. To learn more, see the Vertex AI reference documentation.
Service: aiplatform.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It's used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents.
This service provides the following discovery documents:
- https://aiplatform.googleapis.com/$discovery/rest?version=v1
- https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
REST Resource: notebookRuntimeTemplates
Use v1.projects.locations.notebookRuntimeTemplates to perform
runtime template management tasks, including creating, deleting, and modifying
permissions for a runtime template. For more information, see
v1.projects.locations.notebookRuntimeTemplates.
REST Resource: notebookRuntimes
Use v1.projects.locations.notebookRuntimes to perform
runtime management tasks, including starting, stopping, upgrading, and
deleting the runtime. For more information, see
v1.projects.locations.notebookRuntimes.
REST Resource: notebookExecutionJobs
Use v1.projects.locations.notebookExecutionJobs to manage
executions of notebooks, including creating and deleting notebook executions.
For more information, see
v1.projects.locations.notebookExecutionJobs.