---
updatedAt: 2026-05-28T13:08:21.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/application-security/llms.txt
---

# Modify SIEM settings

__All products__ Update SIEM settings for a specific configuration.

# OpenAPI definition

```json
{
  "externalDocs": {
    "description": "See documentation for Akamai's Application Security API",
    "url": "https://techdocs.akamai.com/application-security/reference"
  },
  "info": {
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Configuration settings",
    "version": "v1"
  },
  "openapi": "3.0.0",
  "paths": {
    "/configs/{configId}/versions/{versionNumber}/siem": {
      "put": {
        "description": "__All products__ Update SIEM settings for a specific configuration.",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Application Security API",
          "url": "https://techdocs.akamai.com/application-security/reference/put-siem"
        },
        "operationId": "put-siem",
        "parameters": [
          {
            "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
            "in": "query",
            "name": "accountSwitchKey",
            "required": false,
            "schema": {
              "example": "1-5C0YLB:1-8BYUX",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "enableForAllPolicies": false,
                "enableSiem": true,
                "enabledBotmanSiemEvents": false,
                "exceptions": [
                  {
                    "actionTypes": [
                      "*"
                    ],
                    "protection": "botmanagement"
                  },
                  {
                    "actionTypes": [
                      "alert"
                    ],
                    "protection": "ipgeo"
                  },
                  {
                    "actionTypes": [
                      "alert"
                    ],
                    "protection": "rate"
                  }
                ],
                "firewallPolicyIds": [
                  "qik2_38799",
                  "4444_44572",
                  "teet_39295",
                  "ds22_48583"
                ],
                "includeJA4FingerprintToSiem": true,
                "siemDefinitionId": 1
              },
              "schema": {
                "additionalProperties": false,
                "description": "Contains Security Information Event Management (SIEM) integration settings.",
                "properties": {
                  "enableForAllPolicies": {
                    "description": "Whether you enabled SIEM for all the security policies in the configuration version.",
                    "type": "boolean"
                  },
                  "enableSiem": {
                    "description": "Whether you enabled SIEM in a security configuration version.",
                    "type": "boolean"
                  },
                  "enabledBotmanSiemEvents": {
                    "deprecated": true,
                    "description": "__Deprecated__ Whether you enabled SIEM for the Bot Manager events. Use `exceptions` parameter instead to set botman siem events exception.",
                    "type": "boolean",
                    "x-akamai": {
                      "status": "DEPRECATED"
                    }
                  },
                  "exceptions": {
                    "description": "Describes all attack type exceptions that will be ignored in SIEM events.",
                    "items": {
                      "additionalProperties": false,
                      "properties": {
                        "actionTypes": {
                          "description": "Describes [actions](https://techdocs.akamai.com/application-security/reference/siem-action-and-attack-type-exceptions) to be excluded for a particular attack type. A `*` value means all actions.",
                          "items": {
                            "enum": [
                              "*",
                              "alert",
                              "deny",
                              "all_custom",
                              "abort",
                              "allow",
                              "delay",
                              "ignore",
                              "monitor",
                              "slow",
                              "tarpit"
                            ],
                            "type": "string"
                          },
                          "type": "array"
                        },
                        "protection": {
                          "description": "[Attack types](https://techdocs.akamai.com/application-security/reference/siem-action-and-attack-type-exceptions) to be added as an exception.",
                          "enum": [
                            "ipgeo",
                            "rate",
                            "urlProtection",
                            "slowpost",
                            "customrules",
                            "waf",
                            "apirequestconstraints",
                            "clientrep",
                            "malwareprotection",
                            "botmanagement",
                            "aprProtection",
                            "aifirewallprotection",
                            "bde"
                          ],
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "firewallPolicyIds": {
                    "description": "The list of security policy identifiers for which to enable the SIEM integration.",
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "includeJA4FingerprintToSiem": {
                    "description": "Whether you enabled JA4 header forwarding for SIEM.",
                    "type": "boolean"
                  },
                  "siemDefinitionId": {
                    "description": "Uniquely identifies the SIEM settings.",
                    "type": "integer"
                  }
                },
                "required": [
                  "enableSiem"
                ],
                "type": "object",
                "x-akamai": {
                  "file-path": "schemas/siem-settings.yaml"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "enableForAllPolicies": false,
                  "enableSiem": true,
                  "enabledBotmanSiemEvents": false,
                  "exceptions": [
                    {
                      "actionTypes": [
                        "*"
                      ],
                      "protection": "botmanagement"
                    },
                    {
                      "actionTypes": [
                        "alert"
                      ],
                      "protection": "ipgeo"
                    },
                    {
                      "actionTypes": [
                        "alert"
                      ],
                      "protection": "rate"
                    }
                  ],
                  "firewallPolicyIds": [
                    "qik2_38799",
                    "4444_44572",
                    "teet_39295",
                    "ds22_48583"
                  ],
                  "includeJA4FingerprintToSiem": true,
                  "siemDefinitionId": 1
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Contains Security Information Event Management (SIEM) integration settings.",
                  "properties": {
                    "enableForAllPolicies": {
                      "description": "Whether you enabled SIEM for all the security policies in the configuration version.",
                      "type": "boolean"
                    },
                    "enableSiem": {
                      "description": "Whether you enabled SIEM in a security configuration version.",
                      "type": "boolean"
                    },
                    "enabledBotmanSiemEvents": {
                      "deprecated": true,
                      "description": "__Deprecated__ Whether you enabled SIEM for the Bot Manager events. Use `exceptions` parameter instead to set botman siem events exception.",
                      "type": "boolean",
                      "x-akamai": {
                        "status": "DEPRECATED"
                      }
                    },
                    "exceptions": {
                      "description": "Describes all attack type exceptions that will be ignored in SIEM events.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "actionTypes": {
                            "description": "Describes [actions](https://techdocs.akamai.com/application-security/reference/siem-action-and-attack-type-exceptions) to be excluded for a particular attack type. A `*` value means all actions.",
                            "items": {
                              "enum": [
                                "*",
                                "alert",
                                "deny",
                                "all_custom",
                                "abort",
                                "allow",
                                "delay",
                                "ignore",
                                "monitor",
                                "slow",
                                "tarpit"
                              ],
                              "type": "string"
                            },
                            "type": "array"
                          },
                          "protection": {
                            "description": "[Attack types](https://techdocs.akamai.com/application-security/reference/siem-action-and-attack-type-exceptions) to be added as an exception.",
                            "enum": [
                              "ipgeo",
                              "rate",
                              "urlProtection",
                              "slowpost",
                              "customrules",
                              "waf",
                              "apirequestconstraints",
                              "clientrep",
                              "malwareprotection",
                              "botmanagement",
                              "aprProtection",
                              "aifirewallprotection",
                              "bde"
                            ],
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "firewallPolicyIds": {
                      "description": "The list of security policy identifiers for which to enable the SIEM integration.",
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "includeJA4FingerprintToSiem": {
                      "description": "Whether you enabled JA4 header forwarding for SIEM.",
                      "type": "boolean"
                    },
                    "siemDefinitionId": {
                      "description": "Uniquely identifies the SIEM settings.",
                      "type": "integer"
                    }
                  },
                  "required": [
                    "enableSiem"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/siem-settings.yaml"
                  }
                }
              }
            },
            "description": "Successfully retrieved SIEM settings."
          },
          "400": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "The request could not be understood by the server due to malformed syntax.",
                  "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                  "status": 400,
                  "title": "Bad Request",
                  "type": "https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Details the errors you can receive.",
                  "properties": {
                    "detail": {
                      "description": "The detailed error message.",
                      "type": "string"
                    },
                    "fieldErrors": {
                      "description": "Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.",
                      "type": "object"
                    },
                    "instance": {
                      "description": "The non-referenceable URI that indicates the error instance.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                      "type": "string"
                    },
                    "status": {
                      "description": "The HTTP status code.",
                      "example": 404,
                      "type": "integer"
                    },
                    "title": {
                      "description": "The error title.",
                      "example": "Not Found",
                      "type": "string"
                    },
                    "type": {
                      "description": "The URL for the error type.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND",
                      "type": "string"
                    }
                  },
                  "required": [
                    "title",
                    "type",
                    "detail",
                    "instance",
                    "status"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem-details.yaml"
                  }
                }
              }
            },
            "description": "[Bad request](ref:400). Invalid request body or URL parameter input.",
            "x-akamai": {
              "file-path": "errors/400.yaml"
            }
          },
          "403": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "You do not have the necessary access to perform this operation or the requested resource cannot be modified",
                  "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                  "status": 403,
                  "title": "Forbidden",
                  "type": "https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Details the errors you can receive.",
                  "properties": {
                    "detail": {
                      "description": "The detailed error message.",
                      "type": "string"
                    },
                    "fieldErrors": {
                      "description": "Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.",
                      "type": "object"
                    },
                    "instance": {
                      "description": "The non-referenceable URI that indicates the error instance.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                      "type": "string"
                    },
                    "status": {
                      "description": "The HTTP status code.",
                      "example": 404,
                      "type": "integer"
                    },
                    "title": {
                      "description": "The error title.",
                      "example": "Not Found",
                      "type": "string"
                    },
                    "type": {
                      "description": "The URL for the error type.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND",
                      "type": "string"
                    }
                  },
                  "required": [
                    "title",
                    "type",
                    "detail",
                    "instance",
                    "status"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem-details.yaml"
                  }
                }
              }
            },
            "description": "[Forbidden](ref:403). You don't have access to the resource.",
            "x-akamai": {
              "file-path": "errors/403.yaml"
            }
          },
          "404": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "The requested resource is not found",
                  "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                  "status": 404,
                  "title": "Not Found",
                  "type": "https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND"
                },
                "schema": {
                  "additionalProperties": true,
                  "description": "Details the errors you can receive.",
                  "properties": {
                    "detail": {
                      "description": "The detailed error message.",
                      "type": "string"
                    },
                    "fieldErrors": {
                      "description": "Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.",
                      "type": "object"
                    },
                    "instance": {
                      "description": "The non-referenceable URI that indicates the error instance.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
                      "type": "string"
                    },
                    "status": {
                      "description": "The HTTP status code.",
                      "example": 404,
                      "type": "integer"
                    },
                    "title": {
                      "description": "The error title.",
                      "example": "Not Found",
                      "type": "string"
                    },
                    "type": {
                      "description": "The URL for the error type.",
                      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND",
                      "type": "string"
                    }
                  },
                  "required": [
                    "title",
                    "type",
                    "detail",
                    "instance",
                    "status"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem-details.yaml"
                  }
                }
              }
            },
            "description": "[Not found](ref:404). That resource doesn't exist, or the URL is malformed.",
            "x-akamai": {
              "file-path": "errors/404.yaml"
            }
          }
        },
        "summary": "Modify SIEM settings",
        "tags": [
          "SIEM settings"
        ],
        "x-akamai": {
          "labels": [
            "All products"
          ]
        }
      },
      "parameters": [
        {
          "description": "A unique identifier for each configuration.",
          "in": "path",
          "name": "configId",
          "required": true,
          "schema": {
            "example": 77653,
            "format": "int64",
            "type": "integer"
          },
          "x-akamai": {
            "file-path": "parameters/config-id-path.yaml"
          }
        },
        {
          "description": "A unique identifier for each version of a configuration.",
          "in": "path",
          "name": "versionNumber",
          "required": true,
          "schema": {
            "example": 25,
            "type": "integer"
          },
          "x-akamai": {
            "file-path": "parameters/version-number-path.yaml"
          }
        }
      ],
      "x-akamai": {
        "file-path": "paths/config-siem.yaml",
        "path-info": "/configs/{configId}/versions/{versionNumber}/siem"
      }
    }
  },
  "servers": [
    {
      "url": "https://{hostname}/appsec/v1"
    }
  ],
  "tags": [
    {
      "description": "Manage SIEM settings for your security configurations.",
      "name": "SIEM settings"
    }
  ],
  "x-akamai": {
    "auth-type": "EDGE_GRID",
    "file-path": "01-configuration.yaml"
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "node"
    ]
  }
}
```

# Sibling pages

* [Get SIEM settings](https://techdocs.akamai.com/application-security/reference/get-siem.md)
* [Get SIEM versions](https://techdocs.akamai.com/application-security/reference/get-siem-definitions.md)