Apply a bulk action to anonymization fields

Base URL: https://{kibana_url}

POST /api/security_ai_assistant/anonymization_fields/_bulk_action

Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Responses

Indicates a successful call.

application/json

anonymization_fields_count integer: Total number of anonymization fields processed.
attributes object required
message string: Message providing information about the bulk action result.
status_code integer: HTTP status code returned.
success boolean: Indicates if the bulk action was successful.

Bad Request response.

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request POST 'http://localhost:5601/api/security_ai_assistant/anonymization_fields/_bulk_action' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"create":[{"field":"host.name","allowed":true,"anonymized":false}]}'

Request

Request example

{
  "create": [
    {
      "allowed": true,
      "anonymized": false,
      "field": "host.name"
    },
    {
      "allowed": false,
      "anonymized": true,
      "field": "user.name"
    }
  ],
  "delete": {
    "ids": [
      "field5",
      "field6"
    ],
    "query": "field: host.name"
  },
  "update": [
    {
      "allowed": true,
      "anonymized": false,
      "id": "field8"
    },
    {
      "allowed": false,
      "anonymized": true,
      "id": "field9"
    }
  ]
}

Response

{
  "anonymization_fields_count": 4,
  "attributes": {
    "results": {
      "created": [
        {
          "allowed": false,
          "anonymized": true,
          "createdAt": "2023-10-31T12:00:00Z",
          "createdBy": "user1",
          "field": "host.name",
          "id": "field2",
          "namespace": "default",
          "timestamp": "2023-10-31T12:00:00Z",
          "updatedAt": "2023-10-31T12:00:00Z",
          "updatedBy": "user1"
        }
      ],
      "deleted": [
        "field3"
      ],
      "skipped": [
        {
          "id": "field4",
          "name": "user.name",
          "skip_reason": "ANONYMIZATION_FIELD_NOT_MODIFIED"
        }
      ],
      "updated": [
        {
          "allowed": true,
          "anonymized": false,
          "createdAt": "2023-10-31T12:00:00Z",
          "createdBy": "user1",
          "field": "url.domain",
          "id": "field8",
          "namespace": "default",
          "timestamp": "2023-10-31T12:00:00Z",
          "updatedAt": "2023-10-31T12:00:00Z",
          "updatedBy": "user1"
        }
      ]
    },
    "summary": {
      "failed": 0,
      "skipped": 1,
      "succeeded": 3,
      "total": 4
    }
  },
  "message": "Bulk action completed successfully",
  "status_code": 200,
  "success": true
}

{
  "error": "Bad Request",
  "message": "Invalid request body",
  "statusCode": 400
}

Authentication

Request body { }

Responses

Request body