Summary
Parse an ip string
Description
Attempt to parse a string as an IP, and return properties of it
Route
POST /policy-manager/validate-ip
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
ip |
string |
yes |
string to parse |
Copied to Clipboard
{
"ip": "sunt non deserunt dolor officia"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"ip": {
"title": "ip",
"type": "string"
}
},
"required": [
"ip"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
ipProperties |
object |
Properties of the ip string |
Copied to Clipboard
{
"valid": false,
"protocol": "v6",
"address": "sit et",
"linklocal": false,
"loopback": false,
"multicast": true,
"global": true,
"private": true,
"reserved": false,
"sitelocal": false,
"teredo": null,
"6to4": "sint officia in do"
}
Copied to Clipboard
{
"title": "ipProperties",
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"enum": [
false
],
"example": false
}
},
"required": [
"valid"
]
},
{
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"enum": [
false
],
"example": false
},
"protocol": {
"type": "string",
"enum": [
"v4"
]
},
"address": {
"type": "string"
},
"linklocal": {
"type": "boolean"
},
"loopback": {
"type": "boolean"
},
"multicast": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"private": {
"type": "boolean"
},
"reserved": {
"type": "boolean"
},
"unspecified": {
"type": "boolean"
}
},
"required": [
"valid",
"protocol",
"address",
"linklocal",
"loopback",
"multicast",
"global",
"private",
"reserved",
"unspecified"
]
},
{
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"enum": [
false
],
"example": false
},
"protocol": {
"type": "string",
"enum": [
"v6"
]
},
"address": {
"type": "string"
},
"linklocal": {
"type": "boolean"
},
"loopback": {
"type": "boolean"
},
"multicast": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"private": {
"type": "boolean"
},
"reserved": {
"type": "boolean"
},
"sitelocal": {
"type": "boolean"
},
"teredo": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 2,
"maxLength": 2
}
]
},
"6to4": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
}
]
}
},
"required": [
"valid",
"protocol",
"address",
"linklocal",
"loopback",
"multicast",
"global",
"private",
"reserved",
"sitelocal",
"teredo",
"6to4"
]
}
]
}