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 https://docs.apigee.com.

Debug Sessions


API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /debugsessions
A session configured in Apigee Edge to record specified messages and associated pipeline processing metadata for debugging purposes
 
Create a debug session Detail
/environments/{environment_name}/apis/{api_name}/revisions/{revision_number}/debugsessions
Verb: POST
Description: Creates a debug session on Apigee
Media types:
application/x-www-url-form-encoded
Auth: Basic Auth
Delete a debug session Detail
/environments/{environment_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_ID}
Verb: DELETE
Description: Deletes a debug session that was previously generated in an environment.
Auth: Basic Auth
Get debug session transaction data Detail
/environments/{environment_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_ID}/data/{transaction_ID}
Verb: GET
Description: Retrieves the data for a transaction in a debug session that was created by the Create debug session APi call or via the Trace tool in the management UI.
Media types:
application/json
text/xml
Auth: Basic Auth
List debug sessions Detail
/environments/{environment_name}/apis/{api_name}/revisions/{revision_number}/debugsessions
Verb: GET
Description: Get a list of debug sessions by ID within an environment.
Media types:
application/json
text/xml
Auth: Basic Auth
Retrieves a list of transaction IDs for a debug session Detail
/environments/{environment_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_ID}/data
Verb: GET
Description: Retrieves a list of transaction IDs for a debug session.
Media types:
application/json
text/xml
Auth: Basic Auth

 

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?)