In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to

Create a debug session with a filter

Resource Summary


Content Type



Debug Session,



Create a debug session with a filter

Create a debug session that captures specific API calls.


This API is an alternative to the basic debug session creation described at Create a debug session. With this API, you can set a filter that captures only API calls that have specific query parameters and/or HTTP headers.


For example, if you wanted to capture only API calls with an Accept: application/json header, you'd create a debug session with that filter.


Filtering API calls in a debug session is particularly useful for root-case analysis to target specific calls that may be causing problems.


The filter is set using query parameters on this API call, in the {filter} portion of the URL. The query parameters begin with either header_ or qparam_ to indicate a header or query parameter. For example:

  • header_name=value: Captures only calls that contain the specific header and value. Header name and value must be URL encoded. For example: header_Accept=application%2Fjson

  • qparam_name=value: Captures only calls that contain the specific query parameter and value. Query parameter name and value must be URL encoded. For example: qparam_user=john%20doe


If you use multiple headers and/or query parameters in the filter, all conditions must be met in order for API call to be captured. Here's how the previous two examples would be combined into a single filter:



The filter query parameters in the API call are combined with the query parameters you set in the fields below.


Resource URL /organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions?{filter}

Query Parameters

Name Values Description

The user-given name of the debug session (used to retrieve the results after debugging completes).


The time in seconds after which the particular session should be discarded. Default is 120 seconds.

Header Parameters

Name Values Description

Request Body

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)