Update Traffic Log Settings

Updates traffic log settings for a specific environment and automatically deploys the changes to the gateway. Supports per-connector settings, method-level overrides, privacy masking, and body size limits.

​

Endpoint

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

​

Authentication

Requires a Personal API Access Token.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

Header	Value	Required
Authorization	Bearer	Yes
Content-Type	application/json	Yes

​

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
apiProxyName	string	Yes	API Proxy name
environmentName	string	Yes	Environment name

​

Request Body

{
  "logParamRequestFromClient": true,
  "logHeaderRequestFromClient": true,
  "logBodyRequestFromClient": true,
  "logParamRequestToTarget": true,
  "logHeaderRequestToTarget": true,
  "logBodyRequestToTarget": true,
  "logHeaderResponseFromTarget": true,
  "logBodyResponseFromTarget": true,
  "logHeaderResponseToClient": true,
  "logBodyResponseToClient": true,
  "enableElasticsearchConnector": true,
  "connectorSettingsMap": {
    "Production Elasticsearch": {
      "enabled": true,
      "logBodyRequestFromClient": true,
      "logBodyResponseFromTarget": true,
      "enableBodyFromClientSize": true,
      "sizeBodyFromClient": 1024
    }
  },
  "methodOverrideList": [
    {
      "apiMethodName": "/pets",
      "connectorSettingsMap": {
        "Production Elasticsearch": {
          "logBodyRequestFromClient": false
        }
      }
    }
  ]
}

​

Request Body Fields

Field	Type	Required	Default	Description
logParamRequestFromClient	boolean	No	true	Log query parameters from client request
logHeaderRequestFromClient	boolean	No	true	Log headers from client request
logBodyRequestFromClient	boolean	No	true	Log body from client request
logParamRequestToTarget	boolean	No	true	Log query parameters sent to target
logHeaderRequestToTarget	boolean	No	true	Log headers sent to target
logBodyRequestToTarget	boolean	No	true	Log body sent to target
logHeaderResponseFromTarget	boolean	No	true	Log headers from target response
logBodyResponseFromTarget	boolean	No	true	Log body from target response
logHeaderResponseToClient	boolean	No	true	Log headers sent to client response
logBodyResponseToClient	boolean	No	true	Log body sent to client response
enableDatabaseConnector	boolean	No	false	Enable database connector
enableElasticsearchConnector	boolean	No	false	Enable Elasticsearch connector
enableSyslogConnector	boolean	No	false	Enable Syslog connector
enableWebhookConnector	boolean	No	false	Enable Webhook connector
enableRabbitMqConnector	boolean	No	false	Enable RabbitMQ connector
enableActiveMqConnector	boolean	No	false	Enable ActiveMQ connector
enableKafkaConnector	boolean	No	false	Enable Kafka connector
enableGraylogConnector	boolean	No	false	Enable Graylog connector
enableLogbackConnector	boolean	No	false	Enable Logback connector
connectorSettingsMap	object	No	Per-connector detailed settings. Key is the connection name as defined in the project. Use the List Connections endpoint to discover available connection names. Legacy connector type keys (e.g., ELASTICSEARCH_INDEX) are also accepted for backward compatibility.
methodOverrideList	array	No	[]	Method-level override list. Only methods that differ from proxy-level settings need entries here.

methodOverrideList[]

Field	Type	Required	Description
apiMethodName	string	Yes	API method endpoint path (e.g., /pets, /users/{id})
connectorSettingsMap	object	No	Per-connector settings override for this method. Same key format as proxy-level connectorSettingsMap.

Note: All fields are optional. Only provided fields are updated. If settings do not exist for the environment, they are created automatically.

​

Response

​

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "logParamRequestFromClient": true,
      "logBodyRequestFromClient": true,
      "connectorSettingsMap": {
        "Production Elasticsearch": {
          "enabled": true
        }
      }
    }
  ],
  "resultCount": 1
}

​

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/trafficLogSettings/production/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "logBodyRequestFromClient": true,
    "logBodyResponseFromTarget": true,
    "enableElasticsearchConnector": true,
    "connectorSettingsMap": {
      "Production Elasticsearch": {
        "enabled": true,
        "logBodyRequestFromClient": true,
        "enableBodyFromClientSize": true,
        "sizeBodyFromClient": 2048
      }
    }
  }'

​

Notes and Warnings

• Automatic Deployment: Changes are automatically deployed to the corresponding environment after save
• Environment-Specific: Settings are scoped to a single environment
• Connector Settings: connectorSettingsMap uses connection names as keys. The system resolves connection names to the matching connector instance in the target environment. Legacy connector type keys (e.g., ELASTICSEARCH_INDEX) continue to work for backward compatibility.
• Method Overrides: Method-level overrides take precedence over proxy-level settings. Use apiMethodName (the endpoint path) to identify methods.

​

Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.

​

Related Documentation

• Get Traffic Log Settings - Get settings for environment
• Update Method Override - Update method-level override
• Delete Method Override - Delete method-level override