/logs/enrichment/configs/{id}

This API allows you to manage a specific log enrichment configuration for a tenant. You can retrieve, update, or delete an existing enrichment configuration using its unique ID.

Retrieves the details of a specific log enrichment configuration by its unique ID for the given tenant.

Path Parameters

  • tenantIdstringrequired

    Describes the ID of the tenant.

  • idstringrequired

    The unique ID of the specific log enrichment configuration.

Responses

  • namestring

    The name of the log enrichment configuration.

  • lookupTableIdstring

    The unique identifier of the lookup table used for enrichment. Applicable only for lookup table-based enrichment.

  • sourceTagsboolean

    Indicates if the enrichment is based on source tags. Set to true for source tag enrichment.

  • filterQuerystring

    The query used to filter logs before applying enrichment.

  • conditionsarray

    A list of condition blocks containing match rules and fields to enrich.

  • priorityOrderinteger

    The execution order of the enrichment configuration. Lower numbers have higher priority.

  • orgIdstring

    The identifier for the organization.

  • createdBystring

    The ID of the user who created the configuration.

  • createdTimestring

    The creation timestamp in epoch format.

  • updatedBystring

    The ID of the user who last updated the configuration.

  • updatedTimestring

    The last update timestamp in epoch format.

  • enricherConfigIdstring

    The unique identifier of the enrichment configuration.

Loading Examples...

Updates an existing log enrichment configuration for the specified tenant.

Path Parameters

  • tenantIdstringrequired

    Describes the ID of the tenant.

  • idstringrequired

    The unique ID of the specific log enrichment configuration.

Request Body

application/json

  • namestring

    Name of the log enrichment lookup table.

  • datastring

    Base64 encoded string containing the lookup table data.

Loading Examples...

Responses

  • namestring

    The name of the log enrichment configuration.

  • sourceTagsboolean

    Set to true if the enrichment is based on source tags. Omit or set to false for lookup table-based enrichment.

  • lookupTableIdstring

    The unique identifier of the lookup table used for enrichment. Required only for lookup table-based enrichment.

  • filterQuerystring

    The filter expression used to select log records, such as matching a specific source.

  • conditionsarray

    A list of enrichment conditions that define matching rules and the fields to enrich.

  • priorityOrderinteger

    Defines the order of execution for the enrichment configurations. Lower value indicates higher priority.

  • orgIdstring

    The organization ID to which the enrichment configuration belongs.

  • createdBystring

    The ID of the user who created the enrichment configuration.

  • createdTimestring

    The timestamp (in epoch format) when the enrichment configuration was created.

  • updatedBystring

    The ID of the user who last updated the enrichment configuration.

  • updatedTimestring

    The timestamp (in epoch format) when the enrichment configuration was last updated.

  • enricherConfigIdstring

    The unique identifier of the enrichment configuration.

Loading Examples...

Deletes the specified log enrichment configuration from the tenant’s environment.

Path Parameters

  • tenantIdstringrequired

    Describes the ID of the tenant.

  • idstringrequired

    The unique ID of the specific log enrichment configuration.

Responses

200OK