NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Method: organizations.environments.apis.revisions.debugsessions.create

Creates a debug session for a deployed API Proxy revision.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}.

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

  • apigee.tracesessions.create

Query parameters


string (int64 format)

Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.

Request body

The request body contains an instance of DebugSession.

Response body

If successful, the response body contains a newly created instance of DebugSession.

Authorization Scopes

Requires the following OAuth scope: