Send Docs Feedback

Create a debug session with a filter

Resource Summary

Security

Content Type

application/x-www-url-form-encoded

Category

Debug Session,

Createadebugsessionwithafilter

POST

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:
 

header_Accept=application%2Fjson&qparam_user=john%20doe

 

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

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions?{filter}

Query Parameters

Name Values Description
session
(required)

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

timeout

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

Header Parameters

Name Values Description
Content-Type
(required)

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?