Edit an Auto YARA job

Update the generated YARA rule on an existing job with revised detection logic.

What this endpoint does

This operation updates the YARA rule string associated with an existing Auto YARA job. After reviewing a rule generated by the Create Auto YARA Job endpoint (retrieved via the Get YARA Job endpoint), use this endpoint to refine or replace the YARA rule logic. The yara_rule_str must be valid YARA syntax; invalid rules will return an error. Note that unlike most other endpoints in this API, the job ID is passed in the request body rather than as a path parameter. Use the Get YARA Jobs endpoint to find job IDs, or save the ID returned when creating a job.

Response data

The response contains the job_id of the updated job, confirming the edit was applied. To verify the updated rule, retrieve the job via the Get YARA Job endpoint and inspect the yara_rule_str field.

Body Params

Request to edit the YARA rule string of an existing job. Requires valid YARA syntax.

string
required

The unique identifier of the job to edit.

string
required

The new YARA rule string to update the job with.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json