About RESTCONF

Based on RFC8040, RESTCONF defines a Hypertext Transfer Protocol (HTTP)-based protocol using Transport Layer Security (TLS) protocol for configuring data defined in a YANG model by using the datastore concepts defined in NETCONF. RESTCONF uses HTTP methods to provide CRUD operations on a conceptual datastore containing YANG-defined data, which is compatible with a server that implements NETCONF data stores.

SLX RESTCONF supports all the operations such as GET, HEAD, OPTIONS, POST, PUT, PATCH, and DELETE method to retrieve the details about the configuration data, YANG schema, and the operational-state data.

The following feature items of the RESTCONF support are different from the existing REST API support.

• RESTCONF uses the Hyper Text Transfer Protocol Secure (HTTPS) protocol .
• The tailf:cli-drop-node-name of the container node defined in the YANG is present in both the URI and the payload, because the abstraction of the RESTCONF protocol mandates that datastore must be same. The content of the abstract copied from the RESTCONF protocol is mentioned below.

  This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastores defined in NETCONF.

• The name of the YANG node is present in the URI and the payload instead of the alt-name.
• There is a key representation in the URI for the LIST element.
• There is the module namespace representation in the URI.
• There is the module namespace representation in the Payload.
• The Resource-Depth header is specified as the query parameter depth in the URI. It specifies the number of nested levels returned in a response for a GET method on API datastores. A "400 Bad Request" status-line will be returned if it used for other methods or resource types.
  • The first nest level will be the requested data node.
  • The value of the "depth" parameter will be either an integer between 1 and 65535, or the string "unbounded". The default depth value is unbounded.
  • For example, the below URL will retrieve all child resources of the interface, with the "depth" parameter set to the default value "unbounded".
    

    GET /restconf/data/brocade-interface:interface?depth=unbounded

• The content query parameter is used to differentiate between the configuration and the operational-state data.
• The with-default query parameter is used with the value trim or report-all-tagged to get the configuration data without default values.
• The Media Type mentioned in the Accept header has been changed.