REredis
secure
processors

Upsert Processors Property

Changed on

Upserts a single processor property by property name. The request body should contain a single 'value' field with the new value for the property. The property name is specified in the URL path.

put/api/v1/pipelines/processors/{prop}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/pipelines/processors/{prop}
  • Auth
    HTTP bearer

Path parameters

prop'on_failed_retry_interval' | 'read_batch_size' | 'dedup' | 'dedup_max_size' | 'dedup_strategy' | 'duration' | 'write_batch_size' | 'error_handling' | 'dlq_max_messages' | 'target_data_type' | 'json_update_strategy' | 'initial_sync_processes' | 'idle_sleep_time_ms' | 'idle_streams_check_interval_ms' | 'busy_streams_check_interval_ms' | 'wait_enabled' | 'wait_timeout' | 'retry_on_replica_failure' required

Request body

valuestring required

Example request

{
  "value": "hash"
}

Response

Successful Response

action_idstring nullable

Example response

{
  "action_id": "1234567890"
}

Changes

  • 38675c1371b2Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • f0a3d26cc0c6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status