Send Docs Feedback

SmartDocs basics

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge email and password (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Create a debug session

Resource Summary

Auth Type


Content Type



Debug Session,



Create a debug session

Create a debug session.

A debug session records detailed information on messages, the Flow processing, and policy execution during processing by an API proxy.

The data returned in the debug session is a single XML or JSON representation of all debug data for each message exchange. The debug data is the same as that used to generate the 'Trace' view in the edge management UI.

A debug session captures a maximum of 10 messages, or records, for a maximum for 2 minutes (by default), whichever comes first.

Debugging involves the following steps:
1. Start a debug session by creating a debug session.
2. Send a message for that deployed API proxy.
3. Retrieve the debug data associated with the debug session. The data can be fetched by issuing a GET call on the session.
4. Close the debug session. (Closing the debug session discards all the associated data).

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

    Query Parameters

  • Name
  • session
    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
  • Content-Type
    Specify the content type as application/x-www-url-form-encoded.

org_name Mention the organization name true

env_name Mention the environment name true

api_name Mention the API name true

revision_number Mention the API revision number true

Basic Auth

OAuth 2

Custom Token


Make a request and see the response.

Make a request and see the response.


Help or comments?