Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Creates a debug session for a deployed API Proxy revision.

post/v1/{+parent}/debugsessions

Path parameters

parentstring required

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}. If the API proxy resource has the space attribute set, IAM permissions are checked differently . To learn more, read the Apigee Spaces Overview.

Query parameters

timeoutstring

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

Request body

namestring

A unique ID for this DebugSession.

validityinteger

Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

timeoutstring int64

Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.

createTimestring google-datetime

Output only. The first transaction creation timestamp, recorded by UAP.

countinteger

Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.

filterstring

Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.

tracesizeinteger

Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.

Response

Successful response