TrafficLogSettings

Update Traffic Log Settings for Specific Environment

Changed on

Partially updates traffic log settings for a specific environment of the specified API Proxy and deploys. Only the fields present in the request body are applied; an omitted (or null) field keeps its stored value. Settings are created with the product defaults if they do not exist yet.

put/apiops/projects/{projectName}/apiProxies/{apiProxyName}/trafficLogSettings/{environmentName}/

Request

Path parameters

projectNamestring required
apiProxyNamestring required
environmentNamestring required

Request body

logParamRequestFromClientboolean

Log query parameters of the request coming from the client. Omitted = unchanged.

logHeaderRequestFromClientboolean

Log headers of the request coming from the client. Omitted = unchanged.

logBodyRequestFromClientboolean

Log body of the request coming from the client. Omitted = unchanged.

logParamRequestToTargetboolean

Log query parameters of the request sent to the target. Omitted = unchanged.

logHeaderRequestToTargetboolean

Log headers of the request sent to the target. Omitted = unchanged.

logBodyRequestToTargetboolean

Log body of the request sent to the target. Omitted = unchanged.

logHeaderResponseFromTargetboolean

Log headers of the response coming from the target. Omitted = unchanged.

logBodyResponseFromTargetboolean

Log body of the response coming from the target. Omitted = unchanged.

logHeaderResponseToClientboolean

Log headers of the response sent to the client. Omitted = unchanged.

logBodyResponseToClientboolean

Log body of the response sent to the client. Omitted = unchanged.

connectorSettingsMapobject

Per-connector settings, keyed by connection name (legacy connector type names are also accepted). Omitted = unchanged; an empty object clears every per-connector setting.

retentionProfile'STANDARD' | 'NO_PAYLOAD' | 'NO_PERSIST'

Data retention profile of this proxy in this environment; null inherits from the project and global settings. Omitted = unchanged.

overrideEnvironmentRestrictionsboolean

Exempts this proxy from the environment connector's detail filter and body size limits. This is the only switch involved; no connector-side permission is required. It never skips privacy masking or the retention profile, and no redeploy is required. Omitted = unchanged.

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultCountinteger

Changes

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      endpoint added