Cloud Debugger is deprecated and will be shutdown May 31, 2023. See the deprecations page and release notes for more information.

Cloud Debugger API

Stay organized with collections Save and categorize content based on your preferences.

The Cloud Debugger API allows applications to interact with the Google Cloud Debugger backends.

It provides two interfaces: the Debugger interface and the Controller interface. The Controller interface allows you to implement an agent that sends state data -- for example, the value of program variables and the call stack -- to Cloud Debugger when the application is running. The Debugger interface allows you to implement a Cloud Debugger client that allows users to set and delete the breakpoints at which the state data is collected, as well as read the data that is captured.

Concepts, data model and operations

See Concepts for information on client roles, the API data model and supported operations.


The Cloud Debugger API supports the following protocols:

  • REST, which allows you to interact with the Cloud Debugger backends using JSON over HTTP.
  • RPC, which allows you to interact with the backends using gRPC. This API doesn't provide gRPC client libraries at this time. If you want to use this interface, you can generate gRPC client code from the service definition following the instructions in the gRPC documentation.


The Cloud Debugger API uses OAuth 2.0 for user authorization. This means that you must set up web application credentials in the Google Cloud console for your project and implement an OAuth 2.0 authorization flow in your client application in order to use the API. See Using OAuth 2.0 to Access Google APIs for more information. You can also see the Authentication page on the gRPC site for information specific to gRPC.

Explore the API

You can use the in-page Try It! feature in the REST interface documentation to explore the API functionality. Try It! helps you understand how to assemble the data that you pass to the API, as well as the structure and content of the data it returns. See the documentation of the register method for an example.