API Errors Dictionary

This document contains the official registry of error codes returned by the REST API and transactional engine.

Nomenclature

All errors follow a structured format: ERR_[CATEGORY]_[TYPE][ID]

1: Syntax, format or bad request errors.
2: Network logic, semantics or conflict validation errors.
3: State, session or transactional engine errors.
4: OS, hardware or kernel level errors.
5: Security, authentication or permission errors.

ERR_NET_1001

Invalid IP or CIDR format

IP address does not comply with network parsing standard.

Example details:192.168.1.999/24

ERR_NET_1003

Resource not found

Requested resource does not exist in config.

ERR_NET_1002

Missing required field

Request is missing a required field to create the resource.

Example details:zone name is required

ERR_NET_2001

Interface acts as parent for VLANs and cannot have IP

Attempt to assign Layer 3 IP to a physical interface operating in Layer 2 as VLAN trunk.

Example details:enp0s8

ERR_NET_2002

Parent interface cannot be down while child VLAN is up

Administrative state conflict. Interface cannot be shut down if its subinterfaces are up.

Example details:parent: enp0s8, vlan: vlan10

ERR_NET_2003

Resource references unknown entity

Resource attempts to link to another that does not exist in the candidate config.

Example details:unknown zone: LAN

ERR_NET_1004

Invalid JSON payload

Request body has invalid JSON format or incorrect types.

ERR_NET_2004

Duplicate IP address detected

Same IP assigned to more than one interface.

ERR_NET_2005

VLAN references unknown parent interface

VLAN attempts to attach to a non-existent physical interface.

ERR_NET_1005

Invalid zone type

Submitted zone type is not recognized by the system.

Example details:Use l2 or l3

ERR_NET_2006

Resource already exists

Attempt to create a resource with an identifier already in use.

Example details:zone LAN already exists

ERR_NET_1006

Invalid protocol

Specified protocol is not valid. Only tcp or udp are allowed.

Example details:protocol: icmp

ERR_NET_1007

Invalid subnet mask

Provided netmask is not valid for IPv4 format.

Example details:invalid mask in address LAN_NET

ERR_NET_1008

Invalid port number

Specified port is outside valid range or is less than or equal to 0.

Example details:invalid port in service HTTP

ERR_NET_1009

Method not allowed

Attempt to access an endpoint with an incorrect HTTP method.

ERR_SEC_1001

Invalid NAT action

Action is not supported. Only masquerade, snat or dnat are allowed.

Example details:action: drop

ERR_SEC_1002

Invalid policy action

Policy action is not recognized. Only allow or deny are allowed.

Example details:action: bypass

ERR_SEC_5001

Missing authorization token

Request does not include Authorization header with JWT token.

ERR_SEC_5002

Invalid token format

Authorization header does not comply with Bearer scheme.

Example details:expected Bearer token

ERR_SEC_5003

Invalid or expired token

JWT token failed validation or has expired.

Example details:token is expired by 10m

ERR_SEC_5004

User account disabled

ERR_SEC_5005

Invalid credentials

Credentials do not match or user does not exist.

ERR_SEC_2001

Invalid policy reference

Policy references a null or invalid object.

Example details:policy has nil service

ERR_SEC_5006

Failed to generate token

Internal server error when attempting to cryptographically sign JWT.

ERR_SYS_3001

No active config session

Attempt to edit resources or commit without beginning session.

ERR_SYS_3002

Config already locked by another user

Attempt to start a config session when another administrator has the lock.

Example details:owner: admin

ERR_SYS_4001

Internal server error

Generic system failure, kernel read or database.

ERR_SYS_3003

Failed to apply runtime configuration

Engine failed to apply configuration to the operating system.

ERR_SYS_3004

Failed to create config backup

Error cloning configuration for rollback.