route.system_routes

Query IPv4 and IPv6 routes from the kernel’s main routing table.

Returns routes currently installed in the system, including static routes, DHCP-learned routes, and directly connected networks. The default route (0.0.0.0/0 or ::/0) will have both network and netmask set to all zeros.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

 No Additional Items
Each item of this array must be:
Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options

options

Type: object
Default:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

 No Additional Properties

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

 No Additional Items
Each item of this array must be:
Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

 No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
    "username",
    "Authentication.status"
]

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Value must be greater or equal to 0

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Value must be greater or equal to 0 and lesser or equal to 10000

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Result


Type: array of object
No Additional Items
Each item of this array must be:

RouteSystemRoutesItem

Type: object
No Additional Properties

Network


Network address for this route.

Type: const
Specific value: ""
Type: string

Netmask


Network mask for this route.

Type: const
Specific value: ""
Type: string

Gateway


Gateway IP address for this route. null if directly connected.

Type: const
Specific value: ""
Type: string
Type: null

Interface


Network interface name for this route. null if not bound to specific interface.

Type: string
Type: null

Flags

Type: array

Array of routing flags for this route.

 No Additional Items
Each item of this array must be:
Type: object

Table Id

Type: integer

Routing table ID where this route is stored.

Scope

Type: integer

Routing scope indicating the distance to the destination.

Preferred Source


Preferred source IP address for outgoing packets. null if not specified.

Type: string
Type: null

RouteSystemRoutesItem

Type: object
No Additional Properties

Network


Network address for this route.

Type: const
Specific value: ""
Type: string

Netmask


Network mask for this route.

Type: const
Specific value: ""
Type: string

Gateway


Gateway IP address for this route. null if directly connected.

Type: const
Specific value: ""
Type: string
Type: null

Interface


Network interface name for this route. null if not bound to specific interface.

Type: string
Type: null

Flags

Type: array

Array of routing flags for this route.

 No Additional Items
Each item of this array must be:
Type: object

Table Id

Type: integer

Routing table ID where this route is stored.

Scope

Type: integer

Routing scope indicating the distance to the destination.

Preferred Source


Preferred source IP address for outgoing packets. null if not specified.

Type: string
Type: null
Type: array of object
No Additional Items
Each item of this array must be:
Type: object
Type: object
Type: integer


Required roles: NETWORK_INTERFACE_READ