vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
  "anchor": "is_ipv4",
  "name": "is_ipv4",
  "category": "IP",
  "description": "Check if the string is a valid IPv4 address or not.\n\nAn [IPv4-mapped](https://datatracker.ietf.org/doc/html/rfc6890) or\n[IPv4-compatible](https://datatracker.ietf.org/doc/html/rfc6890) IPv6 address is not considered\nvalid for the purpose of this function.",
  "arguments": [
    {
      "name": "value",
      "description": "The IP address to check",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "boolean"
    ],
    "rules": [
      "Returns `true` if `value` is a valid IPv4 address.",
      "Returns `false` if `value` is anything else."
    ]
  },
  "examples": [
    {
      "title": "Valid IPv4 address",
      "source": "is_ipv4(\"10.0.102.37\")",
      "return": true
    },
    {
      "title": "Valid IPv6 address",
      "source": "is_ipv4(\"2001:0db8:85a3:0000:0000:8a2e:0370:7334\")",
      "return": false
    },
    {
      "title": "Arbitrary string",
      "source": "is_ipv4(\"foobar\")",
      "return": false
    }
  ],
  "pure": true
}