Skip to main content
Theme
Home

Update Custom Enrichment

PUThttps://api.coralogix.com/mgmt/openapi/5/enrichment-rules/custom-enrichment-rules/v1

Updates a custom enrichment rule.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json

This request data structure is used to update a custom enrichment

    customEnrichmentId#int64required

    The custom enrichment id.

    Possible values: >= 0 and <= 2147483647

    Example: 1
    description#stringrequired

    New human-readable description of the custom enrichment.

    Possible values: <= 255 characters, Value must match regular expression ^[\s\S]*$

    Example: custom_enrichment_description
    file#objectrequiredoneOf
    object
    file.binary#byte

    Binary content of the file encoded as base64. The account's enrichment file size limit applies to the decoded byte size (20971520 bytes / 20 MiB by default); maxLength bounds the base64-encoded string.

    Possible values: <= 27962028 characters

    Example: 0xFABB32
    file.extension#string

    File extension indicating the file format. Only "csv" is currently supported.

    Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^csv$

    Example: csv
    file.name#string

    Name of the file.

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[\s\S]*$

    Example: file_name
    file.size#int64

    Size of the file in bytes.

    Possible values: >= 0 and <= 2147483647

    Example: 100
    file.textual#string

    Textual content of the file as a UTF-8 string. The account's enrichment file size limit applies to the UTF-8 byte size of the content (20971520 bytes / 20 MiB by default); maxLength is an upper bound in characters.

    Possible values: <= 20971520 characters, Value must match regular expression ^[\s\S]*$

    Example: row1,row2 value1,value2
    name#stringrequired

    New human-readable name for the custom enrichment. May contain only letters, digits, and underscores.

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^\w+$

    Example: custom_enrichment_name

Response

application/json

This response data structure is obtained when a custom enrichment is updated

    Custom enrichment.

    message#string

    Human-readable message.

    Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$

    Example: Custom enrichment updated successfully