Setup Guide

Status Error
Codes
Description
201 Created A resource is created and the new resource URI returns in the Location header.
204 No Content The request is successfully completed but no response body returns.
400 Bad Request The request could not be processed because it contains missing or invalid information (such as a validation error on
an input eld, a missing required value, and so on).
401 Unauthorized The request requires user authentication. The response includes a WWW-Authenticate header eld for basic
authentication.
403 Forbidden Access to the resource is denied by the server due to authorization rules.
404 Not Found The requested resource does not exist.
405 Method Not
Allowed
The HTTP method specied in the request (DELETE, GET, HEAD, PATCH, POST, PUT) is not supported for this
resource.
406 Not Acceptable The resource this request identies is not capable of generating the requested representation, specied in the
Accept header or in the format query parameter.
409 Conict This code is used if a request tries to create a resource that already exists.
415 Unsupported
Media Type
The format of the request is not supported.
500 Internal Error The server encountered an unexpected condition which prevented it from fullling the request.
501 Not
Implemented
The server does not (currently) support the functionality required to fulll the request.
503 Unavailable The server is currently unable to handle the request because the resource is being used by someone else or is
temporarily overloaded.
REST API — Protocol Data Unit (PDU) Structure
The following features are supported to congure the REST API.
• Physical interface
• Logical interface
• BGP
• Infrastructure
• Miscellaneous
Each node is printed as: <status> <flags> <name> <opts> <type>.
• <status> is one of the following:
– + for current
– x for deprecated
– o for obsolete
• <flags> is one of the following:
– rw for conguration data
– ro for non-conguration data
– -x for rpcs
– -n for notications
• <name> is the name of the node.
– (<name>) refers that the node is a choice node
REST API
125