# Control rules updated via API

A control's configuration was updated via the controls API.

Endpoint: POST control-rules-updated-via-api
Version: v1
Security: X-Signature

## Security:

  - `X-Signature` (unknown)
    http bearer

## Header parameters:

  - `X-Signature` (string, required)

## Request fields (application/json):

  - `version` (string, required)
    The version of the event.
    Example: 1

  - `id` (string, required)
    The unique identifier for the event. This can be used as an idempotency key.
    Example: c478966c-f927-411c-b919-179832d3d50c

  - `timestamp` (integer, required)
    When the event occurred, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

  - `category` (string, required)
    The category of the event.
    Enum: "AUDIT"

  - `object` (string, required)
    The type of event.
    Enum: "CONTROL_RULES_UPDATED_VIA_API"

  - `friendlyName` (string, required)
    The friendly name of this object. Note: this is subject to change and should not be used to match on this object.
    Example: Control rules updated via API

  - `description` (string, required)
    The description of the event. Note: this is subject to change and should not be used to match on this object.
    Example: API key (SIEM integration key) updated the file download telemetry configuration

  - `actor` (object, required)
    This object contains details about the API Key used in the API request that triggered the audit log.

  - `actor.source` (string, required)
    The source of the action that generated the event.
    Enum: "API"

  - `actor.apiKeyName` (string, required)
    The name given to the API Key at creation time.

  - `actor.apiKeyCreatedBy` (string, required)
    The email address of the admin user that created the API Key.

  - `actor.sourceIpAddress` (string, required)
    The IP address of the actor.

  - `actor.userAgent` (string, required)
    The user agent of the actor, if available.

  - `new` (object, required)
    The full configuration for the control after the update, in the same shape returned by the controls API.

  - `old` (object, required)
    The full configuration for the control before the update, in the same shape returned by the controls API.

## Response 2XX:

  - `2XX` (unknown)
    Return any 2XX status to indicate that the data was received successfully