PUT /v1/extractionRules/{id}

Update an existing field extraction rule. All properties specified in the request are replaced. Missing properties are set to their default values.

Servers

Path parameters

Name Type Required Description
id String Yes

Identifier of the field extraction rule to update.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

parseExpression String Yes

Describes the fields to be parsed.

enabled Boolean Yes

Is the field extraction rule enabled.

scope String Yes

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.