One document matched: draft-ietf-netconf-restconf-13.xml
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?>
<!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
<?rfc toc="yes"?>
<?rfc compact="no"?>
<?rfc subcompact="no"?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc iprnotified="no"?>
<?rfc strict="yes"?>
<rfc ipr="trust200902" category="std"
docName="draft-ietf-netconf-restconf-13" >
<front>
<title abbrev="RESTCONF">RESTCONF Protocol</title>
<author initials="A" surname="Bierman" fullname='Andy Bierman' >
<organization>YumaWorks</organization>
<address>
<email>andy@yumaworks.com</email>
</address>
</author>
<author initials="M" surname="Bjorklund" fullname='Martin Bjorklund' >
<organization>Tail-f Systems</organization>
<address>
<email>mbj@tail-f.com</email>
</address>
</author>
<author initials="K" surname="Watsen" fullname='Kent Watsen' >
<organization>Juniper Networks</organization>
<address>
<email>kwatsen@juniper.net</email>
</address>
</author>
<date/>
<abstract>
<t>
This document describes an HTTP-based protocol that provides
a programmatic interface for accessing data defined in YANG,
using the datastores defined in NETCONF.
</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>
There is a need for standard mechanisms to allow Web applications
to access the configuration data, state data,
data-model specific protocol operations, and event notifications
within a networking device, in a modular and extensible manner.
</t>
<t>
This document defines an HTTP <xref target="RFC7230"/> based protocol called
RESTCONF, for configuring data defined in YANG version 1 <xref target="RFC6020"/> or
YANG version 1.1 <xref target="I-D.ietf-netmod-rfc6020bis"/>, using datastores defined
in NETCONF <xref target="RFC6241"/>.
</t>
<t>
NETCONF defines configuration datastores and
a set of Create, Retrieve, Update, Delete (CRUD) operations
that can be used to access these datastores. The YANG language
defines the syntax and semantics of datastore content,
state data, protocol operations, and event notifications.
</t>
<t>
RESTCONF uses HTTP operations to provide CRUD operations on a
conceptual datastore containing YANG-defined data, which is
compatible with a server which implements NETCONF datastores.
</t>
<t>
If a RESTCONF server is co-located with a NETCONF server,
then there are protocol interactions to be considered,
as described in <xref target="netconf-coexistence"/>.
The server MAY provide access to specific datastores using
operation resources, as described in <xref target="operation-resource"/>.
</t>
<t>
Configuration data and state data are exposed as resources that
can be retrieved with the GET method.
Resources representing configuration data
can be modified with the DELETE, PATCH, POST, and PUT methods.
Data is encoded with either XML <xref target="W3C.REC-xml-20081126"/>
or JSON <xref target="RFC7159"/>.
</t>
<t>
Data-model specific operations defined with the YANG "rpc" or
"action" statements can be invoked with the POST method. Data-model
specific event notifications defined with the YANG "notification"
statement can be accessed.
</t>
<section title="Terminology">
<t>
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14, <xref target="RFC2119"/>.
</t>
<section title="NETCONF">
<t>
The following terms are defined in <xref target="RFC6241"/>:
</t>
<t>
<list style="symbols">
<t>
candidate configuration datastore
</t>
<t>
client
</t>
<t>
configuration data
</t>
<t>
datastore
</t>
<t>
configuration datastore
</t>
<t>
protocol operation
</t>
<t>
running configuration datastore
</t>
<t>
server
</t>
<t>
startup configuration datastore
</t>
<t>
state data
</t>
<t>
user
</t>
</list>
</t>
</section>
<section title="HTTP">
<t>
The following terms are defined in <xref target="RFC3986"/>:
</t>
<t>
<list style="symbols">
<t>
fragment
</t>
<t>
path
</t>
<t>
query
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7230"/>:
</t>
<t>
<list style="symbols">
<t>
header
</t>
<t>
message-body
</t>
<t>
request-line
</t>
<t>
request URI
</t>
<t>
status-line
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7231"/>:
</t>
<t>
<list style="symbols">
<t>
method
</t>
<t>
request
</t>
<t>
resource
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7232"/>:
</t>
<t>
<list style="symbols">
<t>
entity tag
</t>
</list>
</t>
</section>
<section title="YANG">
<t>
The following terms are defined in <xref target="I-D.ietf-netmod-rfc6020bis"/>:
</t>
<t>
<list style="symbols">
<t>
action
</t>
<t>
container
</t>
<t>
data node
</t>
<t>
key leaf
</t>
<t>
leaf
</t>
<t>
leaf-list
</t>
<t>
list
</t>
<t>
non-presence container (or NP-container)
</t>
<t>
ordered-by user
</t>
<t>
presence container (or P-container)
</t>
<t>
RPC operation
</t>
<t>
top-level data node
</t>
</list>
</t>
</section>
<section title="Terms">
<t>
The following terms are used within this document:
</t>
<t>
<list style="symbols">
<t>
API resource: a resource with the media type
"application/yang.api+xml" or "application/yang.api+json".
</t>
<t>
data resource: a resource with the media type
"application/yang.data+xml" or "application/yang.data+json".
Containers, leafs, list entries, anydata and anyxml nodes can be data
resources.
</t>
<t>
datastore resource: a resource with the media type
"application/yang.datastore+xml" or
"application/yang.datastore+json". Represents a datastore.
</t>
<t>
edit operation: a RESTCONF operation on a data resource
using either a POST, PUT, PATCH, or DELETE method.
</t>
<t>
event stream resource: This resource represents
an SSE (Server-Sent Events) event stream. The content consists of text
using the media type "text/event‑stream", as defined by the
HTML5 <xref target="W3C.REC-html5-20141028"/>
specification. Each event represents
one <notification> message generated by the server.
It contains a conceptual system or data-model specific event
that is delivered within an event notification stream.
Also called a "stream resource".
</t>
<t>
media-type: HTTP uses Internet media types <xref target="RFC2046"/> in the Content-Type
and Accept header fields in order to provide open and extensible
data typing and type negotiation.
</t>
<t>
operation: the conceptual RESTCONF operation for a message,
derived from the HTTP method, request URI, headers, and message-body.
</t>
<t>
operation resource: a resource with the media type
"application/yang.operation+xml" or
"application/yang.operation+json".
</t>
<t>
patch: a generic PATCH request on the target datastore
or data resource.
The media type of the message-body content will identify
the patch type in use.
</t>
<t>
plain patch: a specific PATCH request type that can be used
for simple merge operations.
</t>
<t>
query parameter: a parameter (and its value if any),
encoded within the query component of the request URI.
</t>
<t>
RESTCONF capability: An optional RESTCONF protocol feature
supported by the server, which is identified by an IANA registered
NETCONF Capability URI, and advertised with an entry in
the "capability" leaf-list in <xref target="mon-mod"/>.
</t>
<t>
retrieval request: a request using the GET or HEAD methods.
</t>
<t>
target resource: the resource that is associated with
a particular message, identified by the "path" component
of the request URI.
</t>
<t>
schema resource: a resource with the media type
"application/yang". The YANG representation of the schema
can be retrieved by the client with the GET method.
</t>
<t>
stream list: the set of data resource instances that describe
the event stream resources available from the server.
This information is defined in the "ietf‑restconf‑monitoring"
module as the "stream" list. It can be retrieved using the
target resource "{+restconf}/data/ietf‑restconf‑monitoring:restconf‑state/streams/stream".
The stream list contains information about each stream,
such as the URL to retrieve the event stream data.
</t>
</list>
</t>
</section>
<section title="URI Template" anchor="uri-template">
<t>
Throughout this document, the URI template <xref target="RFC6570"/> syntax
"{+restconf}" is used to refer to the RESTCONF API entry point outside
of an example. See <xref target="root-resource-discovery"/> for details.
</t>
<t>
For simplicity, all of the examples in this document assume
"/restconf" as the discovered RESTCONF API root path.
</t>
</section>
<section title="Tree Diagrams">
<t>
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these
diagrams is as follows:
</t>
<t>
<list style="symbols">
<t>
Brackets "[" and "]" enclose list keys.
</t>
<t>
Abbreviations before data node names: "rw" means configuration
data (read-write) and "ro" state data (read-only).
</t>
<t>
Symbols after data node names: "?" means an optional node, "!" means
a presence container, and "*" denotes a list and leaf-list.
</t>
<t>
Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
</t>
<t>
Ellipsis ("...") stands for contents of subtrees that are not shown.
</t>
</list>
</t>
</section>
</section>
<section title="Subset of NETCONF Functionality">
<t>
RESTCONF does not need to mirror the full functionality of the NETCONF
protocol, but it does need to be compatible with NETCONF. RESTCONF
achieves this by implementing a subset of the interaction capabilities
provided by the NETCONF protocol, for instance, by eliminating
datastores and explicit locking.
</t>
<t>
RESTCONF uses HTTP methods to implement the equivalent of NETCONF
operations, enabling basic CRUD operations on a hierarchy of
conceptual resources.
</t>
<t>
The HTTP POST, PUT, PATCH, and DELETE methods are used to
edit data resources represented by YANG data models.
These basic edit operations allow the running configuration
to be altered in an all-or-none fashion.
</t>
<t>
RESTCONF is not intended to replace NETCONF, but rather provide
an additional interface that follows
Representational State Transfer (REST) principles <xref target="rest-dissertation"/>,
and is compatible with a resource-oriented device abstraction.
</t>
<t>
The following figure shows the system components if a RESTCONF server
is co-located with a NETCONF server:
</t>
<figure>
<artwork><![CDATA[
+-----------+ +-----------------+
| Web app | <-------> | |
+-----------+ HTTP | network device |
| |
+-----------+ | +-----------+ |
| NMS app | <-------> | | datastore | |
+-----------+ NETCONF | +-----------+ |
+-----------------+
]]></artwork>
</figure>
<t>
The following figure shows the system components if a RESTCONF server
is implemented in a device that does not have a NETCONF server:
</t>
<figure>
<artwork><![CDATA[
+-----------+ +-----------------+
| Web app | <-------> | |
+-----------+ HTTP | network device |
| |
+-----------------+
]]></artwork>
</figure>
</section>
<section title="Data Model Driven API">
<t>
RESTCONF combines the simplicity of the HTTP protocol with the
predictability and automation potential of a schema-driven API.
Using YANG, a client can predict all management resources, much
like using URI Templates <xref target="RFC6570"/>, but in a more holistic
manner. This strategy obviates the need for responses provided
by the server to contain Hypermedia as the Engine of Application State
(HATEOAS) links, originally described in
Roy Fielding's doctoral dissertation <xref target="rest-dissertation"/>.
</t>
<t>
RESTCONF provides the YANG module capability information
supported by the server, in case the client wants to use it.
The URIs for custom protocol operations and datastore content
are predictable, based on the YANG module definitions.
</t>
<t>
The RESTCONF protocol operates on a conceptual datastore defined with
the YANG data modeling language. The server lists each YANG
module it supports using the "ietf‑yang‑library"
YANG module, defined in <xref target="I-D.ietf-netconf-yang-library"/>.
The server MUST implement the "ietf‑yang‑library" module,
which MUST identify all the YANG modules used by the server.
</t>
<t>
The conceptual datastore contents, data-model-specific
operations and event notifications are identified by this set of
YANG modules.
</t>
<t>
The classification of data as configuration or
non-configuration is derived from the YANG "config" statement.
Data ordering behavior is derived from the YANG "ordered‑by"
statement.
</t>
<t>
The RESTCONF datastore editing model is simple and direct,
similar to the behavior of the :writable-running
capability in NETCONF. Each RESTCONF edit of a datastore
resource is activated upon successful completion of the transaction.
</t>
</section>
<section title="Coexistence with NETCONF" anchor="netconf-coexistence">
<t>
RESTCONF can be implemented on a device that supports NETCONF.
</t>
<t>
If the device supports :writable-running, all edits to configuration
nodes in {+restconf}/data are performed in the running configuration
datastore. The URI template "{+restconf}" is defined in <xref target="uri-template"/>.
</t>
<t>
Otherwise, if the device supports :candidate, all edits to
configuration nodes in {+restconf}/data are performed in the candidate
configuration datastore. The candidate MUST be automatically committed to
running immediately after each successful edit. Any edits from other sources that are
in the candidate datastore will also be committed. If a confirmed-commit
procedure is in progress, then this commit will act as the confirming commit.
If the server is expecting a "persist‑id" parameter to complete the confirmed
commit procedure then the RESTCONF edit operation MUST fail with a
"409 Conflict" status-line.
</t>
<t>
If the device supports :startup, the device MUST automatically
update the non-volatile "startup datastore", after the
running datastore has been updated as
a consequence of a RESTCONF edit operation.
</t>
<t>
If a datastore that would be modified by a RESTCONF operation has an
active lock, the RESTCONF edit operation MUST fail with a
"409 Conflict" status-line.
</t>
</section>
<section title="RESTCONF Extensibility">
<t>
There are two extensibility mechanisms built into RESTCONF:
</t>
<t>
<list style="symbols">
<t>
protocol version
</t>
<t>
optional capabilities
</t>
</list>
</t>
<t>
This document defines version 1 of the RESTCONF protocol.
If a future version of this protocol is defined, then that document
will specify how the new version of RESTCONF is identified.
It is expected that a different entry point {+restconf2} would be defined.
The server will advertise all protocol versions that it supports
in its host-meta data.
</t>
<t>
In this example, the server supports both RESTCONF version 1 and a
fictitious version 2.
</t>
<figure>
<artwork><![CDATA[
Request
-------
GET /.well-known/host-meta HTTP/1.1
Host: example.com
Accept: application/xrd+xml
Response
--------
HTTP/1.1 200 OK
Content-Type: application/xrd+xml
Content-Length: nnn
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0'>
<Link rel='restconf' href='/restconf'/>
<Link rel='restconf2' href='/restconf2'/>
</XRD>
]]></artwork>
</figure>
<t>
RESTCONF also supports a server-defined list of optional capabilities,
which are listed by a server using the "ietf‑restconf‑monitoring" module
defined in <xref target="mon-mod"/>. For example, this document defines
several query parameters in <xref target="query-parameters"/>. Each optional parameter
has a corresponding capability URI defined in <xref target="query-parameter-uri"/>
that is advertised by the server if supported.
</t>
<t>
The "capabilities" list can identify any
sort of server extension. Typically this extension mechanism is used
to identify optional query parameters but it is not limited to that
purpose. For example, the "defaults" URI defined in <xref target="defaults-uri"/>
specifies a mandatory URI identifying server defaults handling behavior.
</t>
<t>
A new sub-resource type could be identified with a capability if
it is optional to implement. Mandatory protocol features and
new resource types require a new revision of the RESTCONF protocol.
</t>
</section>
</section>
<section title="Transport Protocol Requirements">
<section title="Integrity and Confidentiality">
<t>
HTTP <xref target="RFC7230"/> is an application layer protocol that may be layered on
any reliable transport-layer protocol. RESTCONF is defined on top of
HTTP, but due to the sensitive nature of the information conveyed,
RESTCONF requires that the transport-layer protocol provides both data
integrity and confidentiality. A RESTCONF server MUST support the TLS
protocol <xref target="RFC5246"/>. The RESTCONF protocol MUST NOT be used over HTTP
without using the TLS protocol.
</t>
<t>
HTTP/1.1 pipelining MUST be supported by the server.
Responses MUST be sent in the same order that requests are received.
No other versions of HTTP are supported for use with RESTCONF.
</t>
</section>
<section title="HTTPS with X.509v3 Certificates">
<t>
Given the nearly ubiquitous support for HTTP over TLS <xref target="RFC7230"/>,
RESTCONF implementations MUST support the "https" URI scheme, which
has the IANA assigned default port 443.
</t>
<t>
RESTCONF servers MUST present an X.509v3 based certificate when
establishing a TLS connection with a RESTCONF client. The
use the X.509v3 based certificates is consistent with NETCONF over TLS
<xref target="RFC7589"/>.
</t>
</section>
<section title="Certificate Validation">
<t>
The RESTCONF client MUST either use X.509
certificate path validation <xref target="RFC5280"/>
to verify the integrity of the RESTCONF server's TLS certificate,
or match the presented X.509 certificate with locally configured
certificate fingerprints.
</t>
<t>
The presented X.509 certificate MUST also be considered valid if it matches
a locally configured certificate fingerprint. If X.509 certificate path
validation fails and the presented X.509 certificate does not match a
locally configured certificate fingerprint, the connection MUST be
terminated as defined in <xref target="RFC5246"/>.
</t>
</section>
<section title="Authenticated Server Identity">
<t>
The RESTCONF client MUST check the identity of the
server according to Section 6 of <xref target="RFC6125"/>, including processing the
outcome as described in Section 6.6 of <xref target="RFC6125"/>.
</t>
</section>
<section title="Authenticated Client Identity">
<t>
The RESTCONF server MUST authenticate client access to any
protected resource. If the RESTCONF client is not authorized
to access a resource, the server MUST send an HTTP response with
"401 Unauthorized" status-line, as defined in Section 3.1 of
<xref target="RFC7235"/>.
</t>
<t>
To authenticate a client, a RESTCONF server MUST use TLS
based client certificates (Section 7.4.6 of <xref target="RFC5246"/>), or
MUST use any HTTP authentication scheme defined in the
HTTP Authentication Scheme Registry (Section 5.1 in <xref target="RFC7235"/>).
A server MAY also support the combination of both client
certificates and an HTTP client authentication scheme,
with the determination of how to process this combination
left as an implementation decision.
</t>
<t>
The RESTCONF client identity derived from the authentication
mechanism used is hereafter known as the "RESTCONF username" and
subject to the NETCONF Access Control Module (NACM) <xref target="RFC6536"/>.
When a client certificate is presented, the RESTCONF username MUST
be derived using the algorithm defined in Section 7 of <xref target="RFC7589"/>.
For all other cases, when HTTP authentication is used, the
RESTCONF username MUST be provided by the HTTP authentication
scheme used.
</t>
</section>
</section>
<section title="Resources" anchor="resources">
<t>
The RESTCONF protocol operates on a hierarchy of resources, starting
with the top-level API resource itself
(<xref target="root-resource-discovery"/>). Each resource represents a manageable
component within the device.
</t>
<t>
A resource can be considered a collection of data and the
set of allowed methods on that data. It can contain nested child
resources. The child resource types and methods allowed on them are
data-model specific.
</t>
<t>
A resource has a media type identifier, represented
by the "Content‑Type" header in the HTTP response message.
A resource can contain zero or more nested resources.
A resource can be created and deleted independently of its
parent resource, as long as the parent resource exists.
</t>
<t>
All RESTCONF resource types are defined in this document except
specific datastore contents, protocol operations, and event notifications.
The syntax and semantics for these resource types are
defined in YANG modules.
</t>
<t>
The RESTCONF resources are accessed via a set of
URIs defined in this document.
The set of YANG modules supported by the server
will determine the data model specific operations,
top-level data nodes, and event notification messages
supported by the server.
</t>
<t>
The RESTCONF protocol does not include a
data resource discovery mechanism. Instead, the definitions
within the YANG modules advertised by the server
are used to construct a predictable operation or data
resource identifier.
</t>
<section title="Root Resource Discovery" anchor="root-resource-discovery">
<t>
In line with the best practices defined by <xref target="RFC7320"/>, RESTCONF
enables deployments to specify where the RESTCONF API is located.
When first connecting to a RESTCONF server, a RESTCONF client MUST
determine the root of the RESTCONF API. There MUST be exactly
one "restconf" link relation returned by the device.
</t>
<t>
The client discovers this
by getting the "/.well‑known/host‑meta" resource (<xref target="RFC6415"/>) and
using the <Link> element containing the "restconf" attribute :
</t>
<t>
Example returning /restconf:
</t>
<figure>
<artwork><![CDATA[
Request
-------
GET /.well-known/host-meta HTTP/1.1
Host: example.com
Accept: application/xrd+xml
Response
--------
HTTP/1.1 200 OK
Content-Type: application/xrd+xml
Content-Length: nnn
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0'>
<Link rel='restconf' href='/restconf'/>
</XRD>
]]></artwork>
</figure>
<t>
After discovering the RESTCONF API root, the client MUST prepend it to
any subsequent request to a RESTCONF resource.
In this example, the client would use the path "/restconf"
as the RESTCONF entry point.
</t>
<t>
Example returning /top/restconf:
</t>
<figure>
<artwork><![CDATA[
Request
-------
GET /.well-known/host-meta HTTP/1.1
Host: example.com
Accept: application/xrd+xml
Response
--------
HTTP/1.1 200 OK
Content-Type: application/xrd+xml
Content-Length: nnn
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0'>
<Link rel='restconf' href='/top/restconf'/>
</XRD>
]]></artwork>
</figure>
<t>
In this example, the client would use the path "/top/restconf"
as the RESTCONF entry point.
</t>
<t>
The client can now determine the
operation resources supported by the the server.
In this example a custom "play" operation is supported:
</t>
<figure>
<artwork><![CDATA[
Request
-------
GET /top/restconf/operations HTTP/1.1
Host: example.com
Accept: application/yang.api+json
Response
--------
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Last-Modified: Sun, 22 Apr 2012 01:00:14 GMT
Content-Type: application/yang.api+json
{ "operations" : { "example-jukebox:play" : {} } }
]]></artwork>
</figure>
<t>
If the XRD contains more than one link relation, then only the
relation named "restconf" is relevant to this specification.
</t>
</section>
<section title="RESTCONF Media Types">
<t>
The RESTCONF protocol defines a set of application specific media
types to identify each of the available resource types. The following
resource types are defined in RESTCONF:
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Media Types">
<ttcol align='left'> Resource</ttcol>
<ttcol align='left'>Media Type</ttcol>
<c>API</c>
<c>application/yang.api+xml</c>
<c></c>
<c>application/yang.api+json</c>
<c>Datastore</c>
<c>application/yang.datastore+xml</c>
<c></c>
<c>application/yang.datastore+json</c>
<c>Data</c>
<c>application/yang.data+xml</c>
<c></c>
<c>application/yang.data+json</c>
<c>[none]</c>
<c>application/yang.errors+xml</c>
<c></c>
<c>application/yang.errors+json</c>
<c>Operation</c>
<c>application/yang.operation+xml</c>
<c></c>
<c>application/yang.operation+json</c>
<c>Schema</c>
<c>application/yang</c>
</texttable>
<?rfc compact="no"?></section>
<section title="API Resource" anchor="api-resource">
<t>
The API resource contains the entry points for
the RESTCONF datastore and operation resources.
It is the top-level resource located at {+restconf} and has the media type
"application/yang.api+xml" or "application/yang.api+json".
</t>
<t>
YANG Tree Diagram for an API Resource:
</t>
<figure>
<artwork><![CDATA[
+--rw restconf
+--rw data
+--rw operations
+--ro yang-library-version
]]></artwork>
</figure>
<t>
The "application/yang.api" restconf-media-type extension
in the "ietf‑restconf" module
defined in <xref target="module"/> is used to specify the structure and syntax
of the conceptual child resources within the API resource.
</t>
<t>
The API resource can be retrieved with the GET method.
</t>
<t>
This resource has the following child resources:
</t>
<?rfc compact="yes"?><texttable title="RESTCONF API Resource">
<ttcol align='left'> Child Resource</ttcol>
<ttcol align='left'>Description</ttcol>
<c>data</c>
<c>Contains all data resources</c>
<c>operations</c>
<c>Data-model specific operations</c>
<c>yang-library-version</c>
<c>ietf-yang-library module date</c>
</texttable>
<?rfc compact="no"?><section title="{+restconf}/data">
<t>
This mandatory resource represents the combined configuration
and state data resources that can be accessed by a client.
It cannot be created or deleted by the client.
The datastore resource type is defined in <xref target="datastore-resource"/>.
</t>
<t>
Example:
</t>
<t>
This example request by the client
would retrieve only the non-configuration data nodes
that exist within the "library" resource, using the "content"
query parameter (see <xref target="content"/>).
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox/library
?content=nonconfig HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<library xmlns="https://example.com/ns/example-jukebox">
<artist-count>42</artist-count>
<album-count>59</album-count>
<song-count>374</song-count>
</library>
]]></artwork>
</figure>
</section>
<section title="{+restconf}/operations" anchor="restconf-operations">
<t>
This optional resource is a container that provides access to the
data-model specific protocol operations supported by the server.
The server MAY omit this resource if no data-model specific
operations are advertised.
</t>
<t>
Any data-model specific protocol operations defined in the YANG
modules advertised by the server MUST be available as child nodes of
this resource.
</t>
<t>
Operation resources are defined in <xref target="operation-resource"/>.
</t>
</section>
<section title="{+restconf}/yang-library-version" anchor="library-version">
<t>
This mandatory leaf identifies the revision date of the "ietf‑yang‑library"
YANG module that is implemented by this server.
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-yang-library below to the
date in the published ietf-yang-library YANG module, and remove this
note.]
</t>
<t>
Example:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/yang-library-version HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might respond
(response wrapped for display purposes):
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<yang-library-version
xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-library">
2016-04-09
</yang-library-version>
]]></artwork>
</figure>
</section>
</section>
<section title="Datastore Resource" anchor="datastore-resource">
<t>
The "{+restconf}/data" subtree represents the datastore resource type,
which is a collection of configuration data and state data nodes.
</t>
<t>
This resource type is an abstraction of the system's underlying datastore
implementation. It is used to simplify resource
editing for the client. The RESTCONF datastore resource is a
conceptual collection of all configuration and state data
that is present on the device.
</t>
<t>
Configuration edit transaction management and configuration persistence
are handled by the server and not controlled by the client.
A datastore resource can be written directly with
the POST and PATCH methods. Each RESTCONF edit of a datastore resource is
saved to non-volatile storage by the server, if the server supports
non-volatile storage of configuration data.
</t>
<section title="Edit Collision Detection" anchor="edit-collision">
<t>
Two "edit collision detection" mechanisms are provided
in RESTCONF, for datastore and data resources.
</t>
<section title="Timestamp">
<t>
The last change time is maintained and
the "Last‑Modified" (<xref target="RFC7232"/>, Section 2.2) header is returned in the
response for a retrieval request.
The "If‑Unmodified‑Since" header can be used
in edit operation requests to cause the server
to reject the request if the resource has been modified
since the specified timestamp.
</t>
<t>
The server SHOULD maintain a last-modified timestamp for the
top-level {+restconf}/data resource. This timestamp is only
affected by configuration data resources, and MUST NOT be updated
for changes to non-configuration data.
</t>
</section>
<section title="Entity tag">
<t>
A unique opaque string is maintained and
the "ETag" (<xref target="RFC7232"/>, Section 2.3) header is returned in the
response for a retrieval request.
The "If‑Match" header can be used
in edit operation requests to cause the server
to reject the request if the resource entity tag
does not match the specified value.
</t>
<t>
The server MUST maintain an entity tag for the
top-level {+restconf}/data resource.
This entity tag is only
affected by configuration data resources, and MUST NOT be updated
for changes to non-configuration data.
</t>
</section>
<section title="Update Procedure">
<t>
Changes to configuration data resources affect the timestamp
and entity tag to that resource, any ancestor data resources,
and the datastore resource.
</t>
<t>
For example, an edit to disable an interface might be
done by setting the leaf "/interfaces/interface/enabled" to "false".
The "enabled" data node and its ancestors
(one "interface" list instance, and the "interfaces" container)
are considered to be changed. The datastore is considered to be
changed when any top-level configuration data node is changed
(e.g., "interfaces").
</t>
</section>
</section>
</section>
<section title="Data Resource" anchor="data-resource">
<t>
A data resource represents a YANG data node that is a descendant
node of a datastore resource. Each YANG-defined data node can be uniquely
targeted by the request-line of an HTTP operation. Containers,
leafs, leaf-list entries, list entries, anydata and
anyxml nodes are data resources.
</t>
<t>
The representation maintained for each data resource is the YANG
defined subtree for that node. HTTP operations on a data
resource affect both the targeted data node and all
its descendants, if any.
</t>
<t>
For configuration data resources,
the server MAY maintain a last-modified timestamp for the
resource, and return the "Last‑Modified" header when it
is retrieved with the GET or HEAD methods.
</t>
<t>
The "Last‑Modified" header information can be used by a
RESTCONF client in subsequent requests, within the "If‑Modified‑Since"
and "If‑Unmodified‑Since" headers.
</t>
<t>
If maintained, the resource timestamp MUST be set to the current
time whenever the resource
or any configuration resource within the resource is altered.
If not maintained, then the resource timestamp for the datastore
MUST be used instead.
</t>
<t>
This timestamp is only
affected by configuration data resources, and MUST NOT be updated
for changes to non-configuration data.
</t>
<t>
For configuration data resources,
the server SHOULD maintain a resource entity tag for the
resource, and return the "ETag" header when it
is retrieved as the target resource with the GET or HEAD methods.
If maintained, the resource entity tag MUST be updated
whenever the resource
or any configuration resource within the resource is altered.
If not maintained, then the resource entity tag for the datastore
MUST be used instead.
</t>
<t>
The "ETag" header information can be used by a
RESTCONF client in subsequent requests, within the "If‑Match"
and "If‑None‑Match" headers.
</t>
<t>
This entity tag is only
affected by configuration data resources, and MUST NOT be updated
for changes to non-configuration data.
</t>
<t>
A data resource can be retrieved with the GET method.
Data resources are accessed via the "{+restconf}/data" entry point.
This sub-tree is used to retrieve and edit data resources.
</t>
<t>
A configuration data resource can be altered by the client
with some or all of the edit operations, depending on the
target resource and the specific operation. Refer to <xref target="operations"/>
for more details on edit operations.
</t>
<section title="Encoding Data Resource Identifiers in the Request URI" anchor="uri-encoding">
<t>
In YANG, data nodes are identified with an absolute
XPath expression, defined in <xref target="XPath"/>, starting
from the document root to the target resource.
In RESTCONF, URI-encoded path expressions are used instead.
</t>
<t>
A predictable location for a data resource
is important, since applications will code to the YANG
data model module, which uses static naming and defines an
absolute path location for all data nodes.
</t>
<t>
A RESTCONF data resource identifier is not an XPath expression. It is
encoded from left to right, starting with the top-level data node,
according to the "api‑path" rule in <xref target="path-abnf"/>. The node name of
each ancestor of the target resource node is encoded in order, ending
with the node name for the target resource. If a node in the path is
defined in another module than its parent node, then module name
followed by a colon character (":") is prepended to the node name in
the resource identifier. See <xref target="path-abnf"/> for details.
</t>
<t>
If a data node in the path expression is a YANG leaf-list node,
then the leaf-list value MUST be encoded according to the following rules:
</t>
<t>
<list style="symbols">
<t>
The instance-identifier for the leaf-list MUST be encoded
using one path segment <xref target="RFC3986"/>.
</t>
<t>
The path segment is constructed by having the leaf-list name,
followed by an "=" character, followed by the leaf-list value.
(e.g., /restconf/data/top-leaflist=fred).
</t>
</list>
</t>
<t>
If a data node in the path expression is a YANG list node,
then the key values for the list (if any) MUST be encoded
according to the following rules:
</t>
<t>
<list style="symbols">
<t>
The key leaf values for a data resource representing a YANG
list MUST be encoded using one path segment <xref target="RFC3986"/>.
</t>
<t>
If there is only one key leaf value, the path segment is constructed
by having the list name, followed by an "=" character,
followed by the single key leaf value.
</t>
<t>
If there are multiple key leaf values,
the path segment is constructed by having the list name,
followed by the value of each leaf
identified in the "key" statement, encoded
in the order specified in the YANG "key" statement.
Each key leaf value except the last one is followed by a comma
character.
</t>
<t>
The key value is specified as a string, using the
canonical representation for the YANG data type.
Any reserved characters MUST be
percent-encoded, according to <xref target="RFC3986"/>, section 2.1.
</t>
<t>
All the components in the "key" statement MUST be encoded.
Partial instance identifiers are not supported.
</t>
<t>
Since missing key values are not allowed, two consecutive commas
are interpreted as a zero-length string.
(example: list=foo,,baz).
</t>
<t>
The "list‑instance" ABNF rule defined in <xref target="path-abnf"/>
represents the syntax of a list instance identifier.
</t>
<t>
Resource URI values returned in Location headers
for data resources MUST identify the module name, even
if there are no conflicting local names when the resource
is created. This ensures the correct resource will be identified
even if the server loads a new module that the old client
does not know about.
</t>
</list>
</t>
<t>
Examples:
</t>
<figure>
<artwork><![CDATA[
container top {
list list1 {
key "key1 key2 key3";
...
list list2 {
key "key4 key5";
...
leaf X { type string; }
}
}
leaf-list Y {
type uint32;
}
}
]]></artwork>
</figure>
<t>
For the above YANG definition, a target resource URI for leaf "X"
would be encoded as follows (line wrapped for display purposes only):
</t>
<figure>
<artwork><![CDATA[
/restconf/data/example-top:top/list1=key1,key2,key3/
list2=key4,key5/X
]]></artwork>
</figure>
<t>
For the above YANG definition, a target resource URI for leaf-list "Y"
would be encoded as follows:
</t>
<figure>
<artwork><![CDATA[
/restconf/data/example-top:top/Y=instance-value
]]></artwork>
</figure>
<t>
The following example shows how reserved characters are
percent-encoded within a key value. The value of "key1" contains a
comma, single-quote, double-quote, colon, double-quote, space, and
forward slash. (,'":" /). Note that double-quote is not a reserved
characters and does not need to be percent-encoded. The value of
"key2" is the empty string, and the value of "key3" is the string
"foo".
</t>
<t>
Example URL:
</t>
<figure>
<artwork><![CDATA[
/restconf/data/example-top:top/list1=%2C%27"%3A"%20%2F,,foo
]]></artwork>
</figure>
<section title="ABNF For Data Resource Identifiers" anchor="path-abnf">
<t>
The "api‑path" Augmented Backus-Naur Form (ABNF) syntax
is used to construct RESTCONF
path identifiers:
</t>
<figure>
<artwork><![CDATA[
api-path = "/" |
("/" api-identifier
0*("/" (api-identifier | list-instance )))
api-identifier = [module-name ":"] identifier ;; note 1
module-name = identifier
list-instance = api-identifier "=" key-value ["," key-value]*
key-value = string ;; note 1
string = <a quoted or unquoted string>
;; An identifier MUST NOT start with
;; (('X'|'x') ('M'|'m') ('L'|'l'))
identifier = (ALPHA / "_")
*(ALPHA / DIGIT / "_" / "-" / ".")
]]></artwork>
</figure>
<t>
Note 1: The syntax for "api‑identifier" and "key‑value" MUST conform to the
JSON identifier encoding rules in Section 4 of <xref target="I-D.ietf-netmod-yang-json"/>.
</t>
</section>
</section>
<section title="Defaults Handling">
<t>
RESTCONF requires that a server report its default handling mode
(see <xref target="defaults-uri"/> for details). If the optional "with‑defaults" query
parameter is supported by the server, a client may use it to control
retrieval of default values (see <xref target="with-defaults"/> for details).
</t>
<t>
If a leaf or leaf-list is missing from the configuration
and there is a YANG-defined default for that data resource, then
the server MUST use the YANG-defined default as the configured value.
</t>
<t>
If the target of a GET method is a data node
that represents a leaf that has a default value,
and the leaf has not been configured yet, the server MUST
return the default value that is in use by the server.
</t>
<t>
If the target of a GET method is a data node
that represents a container or list that has any child resources
with default values, for the child resources that have not been given
value yet, the server MAY
return the default values that are in use by the server, in accordance
with its reported default handing mode and query parameters passed by the client.
</t>
</section>
</section>
<section title="Operation Resource" anchor="operation-resource">
<t>
An operation resource represents a protocol operation
defined with the YANG "rpc" statement or a data-model specific
action defined with a YANG "action" statement.
It is invoked using a POST method on the operation resource.
</t>
<t>
An RPC operation is invoked as:
</t>
<figure>
<artwork><![CDATA[
POST {+restconf}/operations/<operation>
]]></artwork>
</figure>
<t>
The <operation> field identifies the module name and rpc identifier
string for the desired operation.
</t>
<t>
For example, if "module‑A" defined a "reset" rpc operation, then
invoking the operation from "module‑A" would be requested as follows:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/module-A:reset HTTP/1.1
Server example.com
]]></artwork>
</figure>
<t>
An action is invoked as:
</t>
<figure>
<artwork><![CDATA[
POST {+restconf}/data/<data-resource-identifier>/<action>
]]></artwork>
</figure>
<t>
where <data‑resource‑identifier> contains the path to the data node
where the action is defined, and <action> is the name of the
action.
</t>
<t>
For example, if "module‑A" defined a "reset‑all" action in the
container "interfaces", then invoking this action would be requested
as follows:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/module-A:interfaces/reset-all HTTP/1.1
Server example.com
]]></artwork>
</figure>
<t>
If the "rpc" or "action" statement has an "input" section, then a
message-body MAY be sent by the client in the request, otherwise the
request message MUST NOT include a message-body.
If the "input" objcet tree contains mandatory parameters,
then a message-body MUST be sent by the client.
A mandatory parameter is a leaf or choice with a "mandatory" statement set to "true",
or a list or leaf-list than have a "min‑elements" statement
value greater than zero.
</t>
<t>
If the operation is invoked without errors, and if the "rpc" or "action"
statement has an "output" section, then a message-body MAY be sent by
the server in the response, otherwise the response message MUST NOT
include a message-body in the response message, and MUST send a "204
No Content" status-line instead.
</t>
<t>
If the operation input is not valid, or the operation is invoked but
errors occur, then a message-body
MUST be sent by the server, containing an "errors" resource,
as defined in <xref target="errors-media-type"/>. A detailed example of
an operation resource error response can be found in
<xref target="op-resource-errors"/>.
</t>
<t>
All operation resources representing RPC operations
supported by the server MUST be identified
in the {+restconf}/operations subtree defined in <xref target="restconf-operations"/>.
Operation resources representing YANG actions are not
identified in this subtree since they are invoked
using a URI within the {+restconf}/data subtree.
</t>
<section title="Encoding Operation Resource Input Parameters" anchor="example-ops-mod">
<t>
If the "rpc" or "action" statement has an "input" section, then
the "input" node is provided in the message-body,
corresponding to the YANG data definition statements
within the "input" section.
</t>
<t>
Examples:
</t>
<t>
The following YANG module is used for the RPC operation
examples in this section.
</t>
<figure>
<artwork><![CDATA[
module example-ops {
namespace "https://example.com/ns/example-ops";
prefix "ops";
revision "2016-03-10";
rpc reboot {
input {
leaf delay {
units seconds;
type uint32;
default 0;
}
leaf message { type string; }
leaf language { type string; }
}
}
rpc get-reboot-info {
output {
leaf reboot-time {
units seconds;
type uint32;
}
leaf message { type string; }
leaf language { type string; }
}
}
}
]]></artwork>
</figure>
<t>
The following YANG module is used for the YANG action
examples in this section.
</t>
<figure>
<artwork><![CDATA[
module example-actions {
yang-version 1.1;
namespace "https://example.com/ns/example-actions";
prefix "act";
import ietf-yang-types { prefix yang; }
revision "2016-03-10";
container interfaces {
list interface {
key name;
leaf name { type string; }
action reset {
input {
leaf delay {
units seconds;
type uint32;
default 0;
}
}
}
action get-last-reset-time {
output {
leaf last-reset {
type yang:date-and-time;
mandatory true;
}
}
}
}
}
}
]]></artwork>
</figure>
<t>
RPC Input Example:
</t>
<t>
The client might send the following POST request message
to invoke the "reboot" RPC operation:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/example-ops:reboot HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<input xmlns="https://example.com/ns/example-ops">
<delay>600</delay>
<message>Going down for system maintenance</message>
<language>en-US</language>
</input>
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 25 Apr 2012 11:01:00 GMT
Server: example-server
]]></artwork>
</figure>
<t>
The same example request message is shown here using JSON encoding:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/example-ops:reboot HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+json
{
"example-ops:input" : {
"delay" : 600,
"message" : "Going down for system maintenance",
"language" : "en-US"
}
}
]]></artwork>
</figure>
<t>
Action Input Example:
</t>
<t>
The client might send the following POST request message
to invoke the "reset" action (text wrap for display purposes):
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-actions:interfaces/interface=eth0
/reset HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<input xmlns="https://example.com/ns/example-actions">
<delay>600</delay>
</input>
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 25 Apr 2012 11:01:00 GMT
Server: example-server
]]></artwork>
</figure>
<t>
The same example request message is shown here using JSON encoding
(text wrap for display purposes):
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-actions:interfaces/interface=eth0
/reset HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+json
{ "example-actions:input" : {
"delay" : 600
}
}
]]></artwork>
</figure>
</section>
<section title="Encoding Operation Resource Output Parameters">
<t>
If the "rpc" or "action" statement has an "output" section, then
the "output" node is provided in the message-body,
corresponding to the YANG data definition statements
within the "output" section.
</t>
<t>
The request URI is not returned in the response.
This URI might have context information required to associate
the output to the specific "rpc" or "action"
statement used in the request.
</t>
<t>
Examples:
</t>
<t>
RPC Output Example:
</t>
<t>
The "example‑ops" YANG module defined in <xref target="example-ops-mod"/>
is used for this example.
</t>
<t>
The client might send the following POST request message
to invoke the "get‑reboot‑info" operation:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/example-ops:get-reboot-info HTTP/1.1
Host: example.com
Accept: application/yang.operation+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 25 Apr 2012 11:10:30 GMT
Server: example-server
Content-Type: application/yang.operation+json
{
"example-ops:output" : {
"reboot-time" : 30,
"message" : "Going down for system maintenance",
"language" : "en-US"
}
}
]]></artwork>
</figure>
<t>
The same response is shown here using XML encoding:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 25 Apr 2012 11:10:30 GMT
Server: example-server
Content-Type: application/yang.operation+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<output xmlns="https://example.com/ns/example-ops">
<reboot-time>30</reboot-time>
<message>Going down for system maintenance</message>
<language>en-US</language>
</output>
]]></artwork>
</figure>
<t>
Action Output Example:
</t>
<t>
The "example‑actions" YANG module defined in <xref target="example-ops-mod"/>
is used for this example.
</t>
<t>
The client might send the following POST request message
to invoke the "get‑last‑reset‑time" action:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-actions:interfaces/interface=eth0
/get-last-reset-time HTTP/1.1
Host: example.com
Accept: application/yang.operation+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 25 Apr 2012 11:10:30 GMT
Server: example-server
Content-Type: application/yang.operation+json
{
"example-actions:output" : {
"last-reset" : "2015-10-10T02:14:11Z"
}
}
]]></artwork>
</figure>
</section>
<section title="Encoding Operation Resource Errors" anchor="op-resource-errors">
<t>
If any errors occur while attempting to invoke the operation
or action, then an "errors" media type is returned with the
appropriate error status.
</t>
<t>
Using the "reboot" operation from the example in
<xref target="example-ops-mod"/>,
the client might send the following POST request message:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/example-ops:reboot HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<input xmlns="https://example.com/ns/example-ops">
<delay>-33</delay>
<message>Going down for system maintenance</message>
<language>en-US</language>
</input>
]]></artwork>
</figure>
<t>
The server might respond with an "invalid‑value" error:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 400 Bad Request
Date: Mon, 25 Apr 2012 11:10:30 GMT
Server: example-server
Content-Type: application/yang.errors+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">
<error>
<error-type>protocol</error-type>
<error-tag>invalid-value</error-tag>
<error-path xmlns:ops="https://example.com/ns/example-ops">
/ops:input/ops:delay
</error-path>
<error-message>Invalid input parameter</error-message>
</error>
</errors>
]]></artwork>
</figure>
<t>
The same response is shown here in JSON encoding:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 400 Bad Request
Date: Mon, 25 Apr 2012 11:10:30 GMT
Server: example-server
Content-Type: application/yang.errors+json
{ "ietf-restconf:errors" : {
"error" : [
{
"error-type" : "protocol",
"error-tag" : "invalid-value",
"error-path" : "/example-ops:input/delay",
"error-message" : "Invalid input parameter",
}
]
}
}
]]></artwork>
</figure>
</section>
</section>
<section title="Schema Resource" anchor="schema-resource">
<t>
The server can optionally support retrieval of the YANG modules it
supports. If retrieval is supported, then the "schema"
leaf MUST be present in the associated "module" list entry,
defined in <xref target="I-D.ietf-netconf-yang-library"/>.
</t>
<t>
To retrieve a YANG module, a client first needs to get
the URL for retrieving the schema, which is stored in the
"schema" leaf. Note that there is no required structure
for this URL. The URL value shown below is just an example.
</t>
<t>
The client might send the following GET request message:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/ietf-yang-library:modules-state/module=
example-jukebox,2015-04-04/schema HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Thu, 11 Feb 2016 11:10:30 GMT
Server: example-server
Content-Type: application/yang.data+json
{
"ietf-yang-library:schema":
"https://example.com/mymodules/example-jukebox/2015-04-04"
}
]]></artwork>
</figure>
<t>
Next the client needs to retrieve the actual YANG schema.
</t>
<t>
The client might send the following GET request message:
</t>
<figure>
<artwork><![CDATA[
GET https://example.com/mymodules/example-jukebox/2015-04-04
HTTP/1.1
Host: example.com
Accept: application/yang
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Thu, 11 Feb 2016 11:10:31 GMT
Server: example-server
Content-Type: application/yang
module example-jukebox {
// contents of YANG module deleted for this example...
}
]]></artwork>
</figure>
</section>
<section title="Event Stream Resource" anchor="stream-resource">
<t>
An "event stream" resource represents a source for system generated
event notifications. Each stream is created and modified
by the server only. A client can retrieve a stream resource
or initiate a long-poll server sent event stream,
using the procedure specified in <xref target="receive-notifs"/>.
</t>
<t>
A notification stream functions according to the NETCONF
Notifications specification <xref target="RFC5277"/>. The available streams
can be retrieved from the stream list,
which specifies the syntax and semantics of a stream resource.
</t>
</section>
<section title="Errors Media Type" anchor="errors-media-type">
<t>
An "errors" media type is a collection of error information that
is sent as the message-body in a server response message,
if an error occurs while processing a request message.
It is not considered a resource type because no instances
can be retrieved with a GET request.
</t>
<t>
The "ietf‑restconf" YANG module contains the "application/yang.errors"
restconf-media-type extension which specifies the syntax and
semantics of an "errors" media type.
RESTCONF error handling behavior is defined in <xref target="error-reporting"/>.
</t>
</section>
</section>
<section title="Operations" anchor="operations">
<t>
The RESTCONF protocol uses HTTP methods to identify
the CRUD operation requested for a particular resource.
</t>
<t>
The following table shows how the RESTCONF operations relate to
NETCONF protocol operations:
</t>
<?rfc compact="yes"?><texttable title="CRUD Methods in RESTCONF">
<ttcol align='left'> RESTCONF</ttcol>
<ttcol align='left'>NETCONF</ttcol>
<c>OPTIONS</c>
<c>none</c>
<c>HEAD</c>
<c>none</c>
<c>GET</c>
<c><get-config>, <get></c>
<c>POST</c>
<c><edit-config> (operation="create")</c>
<c>POST</c>
<c>invoke any operation</c>
<c>PUT</c>
<c><edit-config> (operation="create/replace")</c>
<c>PATCH</c>
<c><edit-config> (operation="merge")</c>
<c>DELETE</c>
<c><edit-config> (operation="delete")</c>
</texttable>
<?rfc compact="no"?> <t>
The NETCONF "remove" operation attribute is not supported
by the HTTP DELETE method. The resource must exist or
the DELETE method will fail. The PATCH method is equivalent to
a "merge" operation when using a plain patch (see <xref target="plain-patch"/>);
other media-types may provide more granular control.
</t>
<t>
Access control mechanisms MUST be used to limit what operations
can be used. In particular, RESTCONF is compatible with the
NETCONF Access Control Model (NACM) <xref target="RFC6536"/>, as there is a
specific mapping between RESTCONF and NETCONF operations,
defined in <xref target="operations"/>. The resource path needs
to be converted internally by the server to the corresponding
YANG instance-identifier. Using this information,
the server can apply the NACM access control rules to RESTCONF
messages.
</t>
<t>
The server MUST NOT allow any operation to any resources that
the client is not authorized to access.
</t>
<t>
Operations are applied to a single data resource instance at once.
The server MUST NOT allow any operation to be applied
to multiple instances of a YANG list or leaf-list.
</t>
<t>
Implementation of all methods (except PATCH) are defined in <xref target="RFC7231"/>.
This section defines the RESTCONF protocol usage for
each HTTP method.
</t>
<section title="OPTIONS" anchor="options">
<t>
The OPTIONS method is sent by the client to
discover which methods are supported by the server
for a specific resource (e.g., GET, POST, DELETE, etc.).
The server MUST implement this method.
</t>
<t>
If the PATCH method is supported, then the "Accept‑Patch" header MUST
be supported and returned in the response to the OPTIONS request, as
defined in <xref target="RFC5789"/>.
</t>
</section>
<section title="HEAD" anchor="head">
<t>
The HEAD method is sent by the client to
retrieve just the headers that would be returned
for the comparable GET method, without the response message-body.
It is supported for all resource types, except operation resources.
</t>
<t>
The request MUST contain a request URI
that contains at least the entry point.
The same query parameters supported by the GET method
are supported by the HEAD method.
</t>
<t>
The access control behavior is enforced
as if the method was GET instead of HEAD.
The server MUST respond the same as if the method
was GET instead of HEAD, except that no
response message-body is included.
</t>
</section>
<section title="GET" anchor="get">
<t>
The GET method is sent by the client to
retrieve data and meta-data for a resource.
It is supported for all resource types, except operation
resources.
The request MUST contain a request URI
that contains at least the entry point.
</t>
<t>
The server MUST NOT return any data resources for which the user
does not have read privileges.
If the user is not authorized to read the target resource, an error
response containing a "401 Unauthorized" status-line SHOULD be
returned. A server MAY return a "404 Not Found" status-line, as
described in section 6.5.3 in <xref target="RFC7231"/>.
</t>
<t>
If the user is authorized to read some but not all of
the target resource, the unauthorized content is omitted
from the response message-body, and the authorized content
is returned to the client.
</t>
<t>
If any content is returned to the client, then the server MUST
send a valid response message-body. More than one element
MUST NOT be returned for XML encoding.
</t>
<t>
If a retrieval request for a data resource representing
a YANG leaf-list or list object
identifies more than one instance, and XML encoding
is used in the response, then an error response containing
a "400 Bad Request" status-line MUST be returned by the server.
</t>
<t>
If the target resource of a retrieval request is for an operation
resource
then a "405 Method Not Allowed" status-line MUST be returned by the server.
</t>
<t>
Note that the way that access control is applied to data resources is
completely incompatible with HTTP caching. The Last-Modified
and ETag headers maintained for a data resource are not affected
by changes to the access control rules for that data resource. It is possible
for the representation of a data resource that is visible to
a particular client to be changed without detection via the Last-Modified
or ETag values.
</t>
<t>
Example:
</t>
<t>
The client might request the response headers for an
XML representation of the a specific "album" resource:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:02:40 GMT
Server: example-server
Content-Type: application/yang.data+xml
Cache-Control: no-cache
Pragma: no-cache
ETag: a74eefc993a2b
Last-Modified: Mon, 23 Apr 2012 11:02:14 GMT
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<album xmlns="http://example.com/ns/example-jukebox"
xmlns:jbox="http://example.com/ns/example-jukebox">
<name>Wasting Light</name>
<genre>jbox:alternative</genre>
<year>2011</year>
</album>
]]></artwork>
</figure>
</section>
<section title="POST" anchor="post">
<t>
The POST method is sent by the client to create a data resource
or invoke an operation resource.
The server uses the target resource media type
to determine how to process the request.
</t>
<?rfc compact="yes"?><texttable title="Resource Types that Support POST">
<ttcol align='left'> Type</ttcol>
<ttcol align='left'>Description</ttcol>
<c>Datastore</c>
<c>Create a top-level configuration data resource</c>
<c>Data</c>
<c>Create a configuration data child resource</c>
<c>Operation</c>
<c>Invoke a protocol operation</c>
</texttable>
<?rfc compact="no"?><section title="Create Resource Mode">
<t>
If the target resource type is a datastore or data resource, then the
POST is treated as a request to create a top-level resource or child
resource, respectively. The message-body is expected to contain the
content of a child resource to create within the parent (target
resource). The message-body MUST NOT contain more than one instance
of the expected data resource. The data-model for the child tree
is the subtree as defined by YANG for the child resource.
</t>
<t>
The "insert" and "point" query parameters MUST be supported
by the POST method for datastore and data resources.
These parameters are only allowed if the list or leaf-list
is ordered-by user.
</t>
<t>
If the POST method succeeds,
a "201 Created" status-line is returned and there is
no response message-body. A "Location" header identifying
the child resource that was created MUST be present
in the response in this case.
</t>
<t>
If the data resource already exists, then the POST request MUST
fail and a "409 Conflict" status-line MUST be returned.
</t>
<t>
If the user is not authorized to create the target resource,
an error response containing a "403 Forbidden" status-line SHOULD be
returned. A server MAY return a "404 Not Found" status-line, as
described in section 6.5.3 in <xref target="RFC7231"/>.
All other error responses are handled according to
the procedures defined in <xref target="error-reporting"/>.
</t>
<t>
Example:
</t>
<t>
To create a new "jukebox" resource, the client might send:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data HTTP/1.1
Host: example.com
Content-Type: application/yang.data+json
{ "example-jukebox:jukebox" : {} }
]]></artwork>
</figure>
<t>
If the resource is created, the server might respond as follows. Note
that the "Location" header line is wrapped for display purposes only:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 201 Created
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Location: https://example.com/restconf/data/
example-jukebox:jukebox
Last-Modified: Mon, 23 Apr 2012 17:01:00 GMT
ETag: b3a3e673be2
]]></artwork>
</figure>
<t>
Refer to <xref target="ex-create"/> for more resource creation examples.
</t>
</section>
<section title="Invoke Operation Mode">
<t>
If the target resource type is an operation resource,
then the POST method is treated as a request to invoke that operation.
The message-body (if any) is processed as the operation input
parameters. Refer to <xref target="operation-resource"/> for details
on operation resources.
</t>
<t>
If the POST request succeeds, a "200 OK" status-line
is returned if there is a response message-body, and
a "204 No Content" status-line is returned if there is
no response message-body.
</t>
<t>
If the user is not authorized to invoke the target operation,
an error response containing
a "403 Forbidden" status-line is returned to
the client. All other error responses are handled according to
the procedures defined in <xref target="error-reporting"/>.
</t>
<t>
Example:
</t>
<t>
In this example, the client is invoking the "play" operation
defined in the "example‑jukebox" YANG module.
</t>
<t>
A client might send a "play" request as follows:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/operations/example-jukebox:play HTTP/1.1
Host: example.com
Content-Type: application/yang.operation+json
{
"example-jukebox:input" : {
"playlist" : "Foo-One",
"song-number" : 2
}
}
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 23 Apr 2012 17:50:00 GMT
Server: example-server
]]></artwork>
</figure>
</section>
</section>
<section title="PUT" anchor="put">
<t>
The PUT method is sent by the client to create or replace
the target data resource. A request message-body MUST be present,
representing the new data resource, or the server MUST return
"400 Bad Request" status-line.
</t>
<t>
The only target resource media type that supports PUT is the data
resource. The message-body is expected to contain the
content used to create or replace the target resource.
</t>
<t>
The "insert" (<xref target="insert"/>) and "point" (<xref target="point"/>) query parameters MUST be
supported by the PUT method for data resources.
These parameters are only allowed if the list or leaf-list
is ordered-by user.
</t>
<t>
Consistent with <xref target="RFC7231"/>, if the PUT request creates a new resource,
a "201 Created" status-line is returned. If an existing resource
is modified, a "204 No Content" status-line is returned.
</t>
<t>
If the user is not authorized to create or replace the target resource
an error response containing a "403 Forbidden" status-line SHOULD be
returned. A server MAY return a "404 Not Found" status-line, as
described in section 6.5.3 in <xref target="RFC7231"/>.
All other error responses are handled according to
the procedures defined in <xref target="error-reporting"/>.
</t>
<t>
If the target resource represents a YANG leaf-list, then the
PUT method MUST NOT change the value of the leaf-list instance.
</t>
<t>
If the target resource represents a YANG list instance, then
the PUT method MUST NOT change any key leaf values
in the message-body representation.
</t>
<t>
Example:
</t>
<t>
An "album" child resource defined in the "example‑jukebox" YANG module
is replaced or created if it does not already exist.
</t>
<t>
To replace the "album" resource contents,
the client might send as follows.
Note that the request-line is wrapped
for display purposes only:
</t>
<figure>
<artwork><![CDATA[
PUT /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
Content-Type: application/yang.data+json
{
"example-jukebox:album" : {
"name" : "Wasting Light",
"genre" : "example-jukebox:alternative",
"year" : 2011
}
}
]]></artwork>
</figure>
<t>
If the resource is updated, the server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 23 Apr 2012 17:04:00 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 17:04:00 GMT
ETag: b27480aeda4c
]]></artwork>
</figure>
<t>
The same request is shown here using XML encoding:
</t>
<figure>
<artwork><![CDATA[
PUT /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<album xmlns="http://example.com/ns/example-jukebox"
xmlns:jbox="http://example.com/ns/example-jukebox">
<name>Wasting Light</name>
<genre>jbox:alternative</genre>
<year>2011</year>
</album>
]]></artwork>
</figure>
</section>
<section title="PATCH" anchor="patch">
<t>
RESTCONF uses the HTTP PATCH method defined
in <xref target="RFC5789"/> to provide an extensible framework for
resource patching mechanisms. It is optional to implement
by the server. Each patch mechanism needs a unique
media type. Zero or more patch media types MAY be supported
by the server. The media types supported by a server can be
discovered by the client by sending an OPTIONS request (see
<xref target="options"/>).
</t>
<t>
This document defines one patch mechanism (<xref target="plain-patch"/>). The YANG
PATCH mechanism is defined in <xref target="I-D.ietf-netconf-yang-patch"/>. Other
patch mechanisms may be defined by future specifications.
</t>
<t>
If the target resource instance does not exist, the server MUST NOT
create it.
</t>
<t>
If the PATCH request succeeds, a "200 OK" status-line
is returned if there is a message-body, and "204 No Content"
is returned if no response message-body is sent.
</t>
<t>
If the user is not authorized to alter the target resource
an error response containing a "403 Forbidden" status-line SHOULD be
returned. A server MAY return a "404 Not Found" status-line, as
described in section 6.5.3 in <xref target="RFC7231"/>.
All other error responses are handled according to
the procedures defined in <xref target="error-reporting"/>.
</t>
<section title="Plain Patch" anchor="plain-patch">
<t>
The plain patch mechanism merges the contents of the message body with
the target resource. If the target resource is a datastore resource
(see <xref target="datastore-resource"/>), the message body MUST be either
application/yang.datastore+xml or application/yang.datastore+json. If
then the target resource is a data resource (see <xref target="data-resource"/>),
then the message body MUST be either application/yang.data+xml or
application/yang.data+json.
</t>
<t>
Plain patch can be used to create or update, but not delete, a child
resource within the target resource. Please see
<xref target="I-D.ietf-netconf-yang-patch"/> for an alternate media-type supporting
more granular control. The YANG Patch Media Type allows multiple
sub-operations (e.g., merge, delete) within a single PATCH
operation.
</t>
<t>
If the target resource represents a YANG leaf-list, then the
PATCH method MUST NOT change the value of the leaf-list instance.
</t>
<t>
If the target resource represents a YANG list instance, then
the PATCH method MUST NOT change any key leaf values
in the message-body representation.
</t>
<t>
Example:
</t>
<t>
To replace just the "year" field in the "album" resource
(instead of replacing the entire resource with the PUT method),
the client might send a plain patch as follows.
Note that the request-line is wrapped
for display purposes only:
</t>
<figure>
<artwork><![CDATA[
PATCH /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
If-Match: b8389233a4c
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<album xmlns="http://example.com/ns/example-jukebox">
<year>2011</year>
</album>
]]></artwork>
</figure>
<t>
If the field is updated, the server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 23 Apr 2012 17:49:30 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 17:49:30 GMT
ETag: b2788923da4c
]]></artwork>
</figure>
</section>
</section>
<section title="DELETE" anchor="delete">
<t>
The DELETE method is used to delete the target resource.
If the DELETE request succeeds, a "204 No Content" status-line
is returned, and there is no response message-body.
</t>
<t>
If the user is not authorized to delete the target resource then
an error response containing a "403 Forbidden" status-line SHOULD be
returned. A server MAY return a "404 Not Found" status-line, as
described in section 6.5.3 in <xref target="RFC7231"/>.
All other error responses are handled according to
the procedures defined in <xref target="error-reporting"/>.
</t>
<t>
If the target resource represents a YANG leaf-list or list, then the
PATCH method SHOULD NOT delete more than one such instance.
The server MAY delete more than one instance if
a query parameter is used requesting this behavior.
(Definition of this query parameter is outside the scope
of this document.)
</t>
<t>
Example:
</t>
<t>
To delete a resource such as the "album" resource,
the client might send:
</t>
<figure>
<artwork><![CDATA[
DELETE /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
]]></artwork>
</figure>
<t>
If the resource is deleted, the server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 23 Apr 2012 17:49:40 GMT
Server: example-server
]]></artwork>
</figure>
</section>
<section title="Query Parameters" anchor="query-parameters">
<t>
Each RESTCONF operation allows zero or more query
parameters to be present in the request URI.
The specific parameters that are allowed depends
on the resource type, and sometimes the specific target
resource used, in the request.
</t>
<t>
<list style="symbols">
<t>
Query parameters can be given in any order.
</t>
<t>
Each parameter can appear at most once in a request URI.
</t>
<t>
A default value may apply if the parameter is missing.
</t>
<t>
Query parameter names and values are case-sensitive
</t>
<t>
A server MUST return an error with a '400 Bad Request' status-line
if a query parameter is unexpected.
</t>
</list>
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Query Parameters">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>Methods</ttcol>
<ttcol align='left'>Description</ttcol>
<c>content</c>
<c>GET</c>
<c>Select config and/or non-config data resources</c>
<c>depth</c>
<c>GET</c>
<c>Request limited sub-tree depth in the reply content</c>
<c>fields</c>
<c>GET</c>
<c>Request a subset of the target resource contents</c>
<c>filter</c>
<c>GET</c>
<c>Boolean notification filter for event stream resources</c>
<c>insert</c>
<c>POST, PUT</c>
<c>Insertion mode for ordered-by user data resources</c>
<c>point</c>
<c>POST, PUT</c>
<c>Insertion point for ordered-yb user data resources</c>
<c>start-time</c>
<c>GET</c>
<c>Replay buffer start time for event stream resources</c>
<c>stop-time</c>
<c>GET</c>
<c>Replay buffer stop time for event stream resources</c>
<c>with-defaults</c>
<c>GET</c>
<c>Control retrieval of default values</c>
</texttable>
<?rfc compact="no"?> <t>
Refer to <xref target="ex-query"/> for examples of query parameter usage.
</t>
<t>
If vendors define additional query parameters, they SHOULD use a
prefix (such as the enterprise or organization name) for query
parameter names in order to avoid collisions with other parameters.
</t>
<section title="The "content" Query Parameter" anchor="content">
<t>
The "content" parameter controls how descendant nodes of
the requested data nodes will be processed in the reply.
</t>
<t>
The allowed values are:
</t>
<?rfc compact="yes"?>
<texttable>
<ttcol align='left'>Value</ttcol>
<ttcol align='left'>Description</ttcol>
<c>config</c>
<c>Return only configuration descendant data nodes</c>
<c>nonconfig</c>
<c>Return only non-configuration descendant data nodes</c>
<c>all</c>
<c>Return all descendant data nodes</c>
</texttable>
<?rfc compact="no"?>
<t>
This parameter is only allowed for GET methods on datastore and data
resources. A "400 Bad Request" status-line is returned if used for other
methods or resource types.
</t>
<t>
If this query parameter is not present, the default value is "all".
This query parameter MUST be supported by the server.
</t>
</section>
<section title="The "depth" Query Parameter" anchor="depth">
<t>
The "depth" parameter is used to specify the number of nest levels
returned in a response for a GET method. The first nest-level
consists of the requested data node itself. If the "fields" parameter
(<xref target="fields"/>) is used to select descendant data nodes, these nodes all
have a depth value of 1. This has the effect of including the
nodes specified by the fields, even if the "depth" value is less
than the actual depth level of the specified fields.
Any child nodes which are contained within a
parent node have a depth value that is 1 greater than its parent.
</t>
<t>
The value of the "depth" parameter is either an integer between 1 and
65535, or the string "unbounded". "unbounded" is the default.
</t>
<t>
This parameter is only allowed for GET methods on API, datastore, and
data resources. A "400 Bad Request" status-line is returned if it used for
other methods or resource types.
</t>
<t>
More than one "depth" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
By default, the server will include all sub-resources within a
retrieved resource, which have the same resource type as the requested
resource. Only one level of sub-resources with a different media type
than the target resource will be returned. The exception is
the datastore resource. If this resource type is retrieved then
by default the datastore and all child data resources are returned.
</t>
<t>
If the "depth" query parameter URI is listed in
the "capability" leaf-list in <xref target="mon-mod"/>, then the server
supports the "depth" query parameter.
</t>
</section>
<section title="The "fields" Query Parameter" anchor="fields">
<t>
The "fields" query parameter is used to optionally identify
data nodes within the target resource to be retrieved in a
GET method. The client can use this parameter to retrieve
a subset of all nodes in a resource.
</t>
<t>
A value of the "fields" query parameter matches the
following rule:
</t>
<figure>
<artwork><![CDATA[
fields-expr = path '(' fields-expr ')' /
path ';' fields-expr /
path
path = api-identifier [ '/' path ]
]]></artwork>
</figure>
<t>
"api‑identifier" is defined in <xref target="path-abnf"/>.
</t>
<t>
";" is used to select multiple nodes. For example, to
retrieve only the "genre" and "year" of an album, use:
"fields=genre;year".
</t>
<t>
Parentheses are used to specify sub-selectors of a node.
</t>
<t>
For example, assume the target resource is the "album" list.
To retrieve only the "label" and
"catalogue‑number" of the "admin" container within an album, use:
"fields=admin(label;catalogue‑number)".
</t>
<t>
"/" is used in a path to retrieve a child node of a node.
For example, to retrieve only the "label" of an album, use:
"fields=admin/label".
</t>
<t>
This parameter is only allowed for GET methods on api,
datastore, and data resources. A "400 Bad Request" status-line
is returned if used for other methods or resource types.
</t>
<t>
More than one "fields" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
If the "fields" query parameter URI is listed in the
"capability" leaf-list in <xref target="mon-mod"/>, then the server
supports the "fields" parameter.
</t>
</section>
<section title="The "filter" Query Parameter" anchor="filter">
<t>
The "filter" parameter is used to indicate which subset of
all possible events are of interest. If not present, all
events not precluded by other parameters will be sent.
</t>
<t>
This parameter is only allowed for GET methods on a
text/event-stream data resource. A "400 Bad Request" status-line
is returned if used for other methods or resource types.
</t>
<t>
The format of this parameter is an XPath 1.0 expression, and is
evaluated in the following context:
</t>
<t>
<list style="symbols">
<t>
The set of namespace declarations is the set of
prefix and namespace pairs for all supported YANG
modules, where the prefix is the YANG module name, and
the namespace is as defined by the "namespace" statement
in the YANG module.
</t>
<t>
The function library is the core function library defined
in XPath 1.0.
</t>
<t>
The set of variable bindings is empty.
</t>
<t>
The context node is the root node.
</t>
</list>
</t>
<t>
More than one "filter" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
The filter is used as defined in <xref target="RFC5277"/>, Section 3.6.
If the boolean result of the expression is true when applied
to the conceptual "notification" document root, then the
event notification is delivered to the client.
</t>
<t>
If the "filter" query parameter URI is listed in the "capability" leaf-list
in <xref target="mon-mod"/>, then the server supports the "filter" query parameter.
</t>
</section>
<section title="The "insert" Query Parameter" anchor="insert">
<t>
The "insert" parameter is used to specify how a
resource should be inserted within a ordered-by user list.
</t>
<t>
The allowed values are:
</t>
<?rfc compact="yes"?>
<texttable>
<ttcol align='left'>Value</ttcol>
<ttcol align='left'>Description</ttcol>
<c>first</c>
<c>Insert the new data as the new first entry.</c>
<c>last</c>
<c>Insert the new data as the new last entry.</c>
<c>before</c>
<c>Insert the new data before the insertion point, as specified by the value of the "point" parameter.</c>
<c>after</c>
<c>Insert the new data after the insertion point, as specified by the value of the "point" parameter.</c>
</texttable>
<?rfc compact="no"?>
<t>
The default value is "last".
</t>
<t>
This parameter is only supported for the POST and PUT
methods. It is also only supported if the target
resource is a data resource, and that data represents
a YANG list or leaf-list that is ordered-by user.
</t>
<t>
More than one "insert" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
If the values "before" or "after" are used,
then a "point" query parameter for the insertion
parameter MUST also be present, or a "400 Bad Request"
status-line is returned.
</t>
<t>
The "insert" query parameter MUST be supported by the server.
</t>
</section>
<section title="The "point" Query Parameter" anchor="point">
<t>
The "point" parameter is used to specify the
insertion point for a data resource that is being
created or moved within an ordered-by user list or leaf-list.
</t>
<t>
The value of the "point" parameter is a string that identifies
the path to the insertion point object. The format is
the same as a target resource URI string.
</t>
<t>
This parameter is only supported for the POST and PUT
methods. It is also only supported if the target
resource is a data resource, and that data represents
a YANG list or leaf-list that is ordered-by user.
</t>
<t>
If the "insert" query parameter is not present, or has
a value other than "before" or "after", then a "400 Bad Request"
status-line is returned.
</t>
<t>
More than one "point" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
This parameter contains the instance identifier of the
resource to be used as the insertion point for a
POST or PUT method.
</t>
<t>
The "point" query parameter MUST be supported by the server.
</t>
</section>
<section title="The "start-time" Query Parameter" anchor="start-time">
<t>
The "start‑time" parameter is used to trigger
the notification replay feature and indicate
that the replay should start at the time specified.
If the stream does not support replay, per the
"replay‑support" attribute returned by stream list
entry for the stream resource, then the server MUST
return a "400 Bad Request" status-line.
</t>
<t>
The value of the "start‑time" parameter is of type
"date‑and‑time", defined in the "ietf‑yang" YANG module
<xref target="RFC6991"/>.
</t>
<t>
This parameter is only allowed for GET methods on a
text/event-stream data resource. A "400 Bad Request" status-line
is returned if used for other methods or resource types.
</t>
<t>
More than one "start‑time" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
If this parameter is not present, then a replay subscription
is not being requested. It is not valid to specify start
times that are later than the current time. If the value
specified is earlier than the log can support, the replay
will begin with the earliest available notification.
</t>
<t>
If this query parameter is supported by the server, then the
"replay" query parameter URI MUST be listed in the "capability" leaf-list
in <xref target="mon-mod"/>. The "stop‑time" query parameter MUST also be supported
by the server.
</t>
<t>
If the "replay‑support" leaf has the value 'true' in the "stream"
entry (defined in <xref target="mon-mod"/>) then the server MUST support
the "start‑time" and "stop‑time" query parameters for that stream.
</t>
</section>
<section title="The "stop-time" Query Parameter" anchor="stop-time">
<t>
The "stop‑time" parameter is used with the
replay feature to indicate the newest notifications of
interest. This parameter MUST be used with and have a
value later than the "start‑time" parameter.
</t>
<t>
The value of the "stop‑time" parameter is of type
"date‑and‑time", defined in the "ietf‑yang" YANG module
<xref target="RFC6991"/>.
</t>
<t>
This parameter is only allowed for GET methods on a
text/event-stream data resource. A "400 Bad Request" status-line
is returned if used for other methods or resource types.
</t>
<t>
More than one "stop‑time" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
If this parameter is not present, the notifications will
continue until the subscription is terminated.
Values in the future are valid.
</t>
<t>
If this query parameter is supported by the server, then the
"replay" query parameter URI MUST be listed in the "capability" leaf-list
in <xref target="mon-mod"/>. The "start‑time" query parameter MUST also be supported
by the server.
</t>
<t>
If the "replay‑support" leaf is present in the "stream"
entry (defined in <xref target="mon-mod"/>) then the server MUST support
the "start‑time" and "stop‑time" query parameters for that stream.
</t>
</section>
<section title="The "with-defaults" Query Parameter" anchor="with-defaults">
<t>
The "with‑defaults" parameter is used to specify how
information about default data nodes should be returned
in response to GET requests on data resources.
</t>
<t>
If the server supports this capability, then it MUST implement
the behavior in Section 4.5.1 of <xref target="RFC6243"/>, except applied to
the RESTCONF GET operation, instead of the NETCONF operations.
</t>
<?rfc compact="yes"?>
<texttable>
<ttcol align='left'>Value</ttcol>
<ttcol align='left'>Description</ttcol>
<c>report-all</c>
<c>All data nodes are reported</c>
<c>trim</c>
<c>Data nodes set to the YANG default are not reported</c>
<c>explicit</c>
<c>Data nodes set to the YANG default by the client are reported</c>
<c>report-all-tagged</c>
<c>All data nodes are reported and defaults are tagged</c>
</texttable>
<?rfc compact="no"?>
<t>
If the "with‑defaults" parameter is set to "report‑all" then the server MUST
adhere to the defaults reporting behavior defined in
Section 3.1 of <xref target="RFC6243"/>.
</t>
<t>
If the "with‑defaults" parameter is set to "trim" then the server MUST
adhere to the defaults reporting behavior defined in
Section 3.2 of <xref target="RFC6243"/>.
</t>
<t>
If the "with‑defaults" parameter is set to "explicit" then the server MUST
adhere to the defaults reporting behavior defined in
Section 3.3 of <xref target="RFC6243"/>.
</t>
<t>
If the "with‑defaults" parameter is set to "report‑all‑tagged"
then the server MUST adhere to the defaults reporting behavior defined in
Section 3.4 of <xref target="RFC6243"/>.
</t>
<t>
More than one "with‑defaults" query parameter MUST NOT appear in a request.
If more than one instance is present, then a "400 Bad Request"
status-line MUST be returned by the server.
</t>
<t>
If the "with‑defaults" parameter is not present
then the server MUST adhere to the defaults reporting behavior defined in
its "basic‑mode" parameter for the "defaults" protocol capability URI,
defined in <xref target="defaults-uri"/>.
</t>
<t>
If the server includes the "with‑defaults" query parameter URI in
the "capability" leaf-list in <xref target="mon-mod"/>, then the "with‑defaults"
query parameter MUST be supported.
</t>
</section>
</section>
</section>
<section title="Messages" anchor="messages">
<t>
The RESTCONF protocol uses HTTP entities for messages.
A single HTTP message corresponds to a single protocol method.
Most messages can perform a single task on a single resource,
such as retrieving a resource or editing a resource.
The exception is the PATCH method, which allows multiple datastore
edits within a single message.
</t>
<section title="Request URI Structure">
<t>
Resources are represented with URIs following the structure
for generic URIs in <xref target="RFC3986"/>.
</t>
<t>
A RESTCONF operation is derived from the HTTP method
and the request URI, using the following conceptual fields:
</t>
<figure>
<artwork><![CDATA[
<OP> /<restconf>/<path>?<query>#<fragment>
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
^ ^ ^ ^ ^
| | | | |
method entry resource query fragment
M M O O I
M=mandatory, O=optional, I=ignored
where:
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<OP> is the HTTP method
<restconf> is the RESTCONF entry point
<path> is the Target Resource URI
<query> is the query parameter list
<fragment> is not used in RESTCONF
]]></artwork>
</figure>
<t>
<list style="symbols">
<t>
method: the HTTP method identifying the RESTCONF operation
requested by the client, to act upon the target resource
specified in the request URI. RESTCONF operation details are
described in <xref target="operations"/>.
</t>
<t>
entry: the root of the RESTCONF API configured on this HTTP
server, discovered by getting the "/.well‑known/host‑meta"
resource, as described in <xref target="root-resource-discovery"/>.
</t>
<t>
resource: the path expression identifying the resource
that is being accessed by the operation.
If this field is not present, then the target resource
is the API itself, represented by the media type "application/yang.api".
</t>
<t>
query: the set of parameters associated with the RESTCONF
message. These have the familiar form of "name=value" pairs.
Most query parameters are optional to implement by the server
and optional to use by the client. Each optional query parameter is
identified by a URI. The server MUST list the
optional query parameter URIs it supports in the "capabilities"
list defined in <xref target="mon-mod"/>.
</t>
</list>
</t>
<t>
There is a specific set of parameters defined,
although the server MAY choose to support query
parameters not defined in this document.
The contents of the any query parameter value MUST be encoded
according to <xref target="RFC3986"/>, Section 3.4. Any reserved characters
MUST be percent-encoded, according to <xref target="RFC3986"/>, section 2.1.
</t>
<t>
<list style="symbols">
<t>
fragment: This field is not used by the RESTCONF protocol.
</t>
</list>
</t>
<t>
When new resources are created by the client, a "Location" header
is returned, which identifies the path of the newly created resource.
The client uses this exact path identifier to access
the resource once it has been created.
</t>
<t>
The "target" of an operation is a resource.
The "path" field in the request URI represents
the target resource for the operation.
</t>
<t>
Refer to <xref target="main-examples"/> for examples of RESTCONF Request URIs.
</t>
</section>
<section title="Message Encoding">
<t>
RESTCONF messages are encoded in HTTP according to <xref target="RFC7230"/>.
The "utf‑8" character set is used for all messages.
RESTCONF message content is sent in the HTTP message-body.
</t>
<t>
Content is encoded in either JSON or XML format.
A server MUST support XML or JSON encoding.
XML encoding rules for data nodes are defined in <xref target="I-D.ietf-netmod-rfc6020bis"/>.
The same encoding rules are used for all XML content.
JSON encoding rules are defined in <xref target="I-D.ietf-netmod-yang-json"/>.
JSON encoding of meta-data is defined in <xref target="I-D.ietf-netmod-yang-metadata"/>.
This encoding is valid JSON, but also has
special encoding rules to identify module namespaces
and provide consistent type processing of YANG data.
</t>
<t>
Request input content encoding format is identified with the Content-Type
header. This field MUST be present if a message-body is sent
by the client.
</t>
<t>
The server MUST support the "Accept" header and "406 Not Acceptable"
status-line, as defined in <xref target="RFC7231"/>.
Response output content encoding format is identified with the Accept
header in the request. If it is not specified, the request
input encoding format SHOULD be used, or the server MAY choose
any supported content encoding format.
</t>
<t>
If there was no request input, then the default output encoding
is XML or JSON, depending on server preference.
File extensions encoded in the request are not used to identify
format encoding.
</t>
</section>
<section title="RESTCONF Meta-Data">
<t>
The RESTCONF protocol needs to retrieve the same meta-data that is
used in the NETCONF protocol. Information about default leafs,
last-modified timestamps, etc. are commonly used to annotate
representations of the datastore contents. This meta-data
is not defined in the YANG schema because it applies to the
datastore, and is common across all data nodes.
</t>
<t>
This information is encoded as attributes in XML.
JSON encoding of meta-data is defined in <xref target="I-D.ietf-netmod-yang-metadata"/>.
</t>
<t>
The following examples are based on the example in <xref target="with-defaults-example"/>.
The "report‑all‑tagged" mode for the "with‑defaults" query parameter
requires that a "default" attribute be returned for default nodes.
This example shows that attribute for the "mtu" leaf .
</t>
<section title="XML MetaData Encoding Example">
<figure>
<artwork><![CDATA[
GET /restconf/data/interfaces/interface=eth1
?with-defaults=report-all-tagged HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might respond as follows.
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<interface
xmlns="urn:example.com:params:xml:ns:yang:example-interface">
<name>eth1</name>
<mtu xmlns:wd="urn:ietf:params:xml:ns:netconf:default:1.0"
wd:default="true">1500</mtu>
<status>up</status>
</interface>
]]></artwork>
</figure>
</section>
<section title="JSON MetaData Encoding Example">
<t>
Note that RFC 6243 defines the "default" attribute with XSD, not YANG,
so the YANG module name has to be assigned manually.
The value "ietf‑netconf‑with‑defaults" is assigned for JSON meta-data
encoding.
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/interfaces/interface=eth1
?with-defaults=report-all-tagged HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond as follows.
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.data+json
{
"example:interface": [
{
"name" : "eth1",
"mtu" : 1500,
"@mtu": {
"ietf-netconf-with-defaults:default" : true
},
"status" : "up"
}
]
}
]]></artwork>
</figure>
</section>
</section>
<section title="Return Status">
<t>
Each message represents some sort of resource access.
An HTTP "status‑line" header line is returned for each request.
If a 4xx or 5xx range status code is returned in the status-line,
then the error information will be returned in the response,
according to the format defined in <xref target="errors"/>.
</t>
</section>
<section title="Message Caching">
<t>
Since the datastore contents change at unpredictable times,
responses from a RESTCONF server generally SHOULD NOT be cached.
</t>
<t>
The server SHOULD include a "Cache‑Control" header in every response
that specifies whether the response should be cached. A "Pragma"
header specifying "no‑cache" MAY also be sent in case the
"Cache‑Control" header is not supported.
</t>
<t>
Instead of relying on HTTP caching, the client SHOULD track the "ETag"
and/or "Last‑Modified" headers returned by the server for the
datastore resource (or data resource if the server supports it).
A retrieval request for a resource can include
the "If‑None‑Match" and/or "If‑Modified‑Since" headers, which
will cause the server to return a "304 Not Modified" status-line
if the resource has not changed.
The client MAY use the HEAD method to retrieve just
the message headers, which SHOULD include the "ETag"
and "Last‑Modified" headers, if this meta-data is maintained
for the target resource.
</t>
</section>
</section>
<section title="Notifications" anchor="notifications">
<t>
The RESTCONF protocol supports YANG-defined event notifications. The
solution preserves aspects of NETCONF Event Notifications <xref target="RFC5277"/>
while utilizing the Server-Sent Events <xref target="W3C.CR-eventsource-20121211"/>
transport strategy.
</t>
<section title="Server Support">
<t>
A RESTCONF server MAY support RESTCONF notifications.
Clients may determine if a server supports RESTCONF notifications by
using the HTTP operation OPTIONS, HEAD, or GET on the stream list.
The server does not support RESTCONF notifications if an HTTP error
code is returned (e.g., "404 Not Found" status-line).
</t>
</section>
<section title="Event Streams">
<t>
A RESTCONF server that supports notifications will populate a
stream resource for each notification delivery service access point.
A RESTCONF client can retrieve the list of supported event streams from
a RESTCONF server using the GET operation on the stream list.
</t>
<t>
The "restconf‑state/streams" container definition in
the "ietf‑restconf‑monitoring" module
(defined in <xref target="mon-mod"/>) is used to specify the structure and syntax
of the conceptual child resources within the "streams" resource.
</t>
<t>
For example:
</t>
<t>
The client might send the following request:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/ietf-restconf-monitoring:restconf-state/
streams HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might send the following response:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Content-Type: application/yang.api+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<streams
xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring">
<stream>
<name>NETCONF</name>
<description>default NETCONF event stream
</description>
<replay-support>true</replay-support>
<replay-log-creation-time>
2007-07-08T00:00:00Z
</replay-log-creation-time>
<access>
<encoding>xml</encoding>
<location>https://example.com/streams/NETCONF
</location>
</access>
<access>
<encoding>json</encoding>
<location>https://example.com/streams/NETCONF-JSON
</location>
</access>
</stream>
<stream>
<name>SNMP</name>
<description>SNMP notifications</description>
<replay-support>false</replay-support>
<access>
<encoding>xml</encoding>
<location>https://example.com/streams/SNMP</location>
</access>
</stream>
<stream>
<name>syslog-critical</name>
<description>Critical and higher severity
</description>
<replay-support>true</replay-support>
<replay-log-creation-time>
2007-07-01T00:00:00Z
</replay-log-creation-time>
<access>
<encoding>xml</encoding>
<location>
https://example.com/streams/syslog-critical
</location>
</access>
</stream>
</streams>
]]></artwork>
</figure>
</section>
<section title="Subscribing to Receive Notifications" anchor="receive-notifs">
<t>
RESTCONF clients can determine the URL for the subscription resource
(to receive notifications) by sending an
HTTP GET request for the "location" leaf with the stream list
entry. The value returned by the server can be used for the actual
notification subscription.
</t>
<t>
The client will send an HTTP GET request for the URL returned
by the server with the "Accept" type "text/event‑stream".
</t>
<t>
The server will treat the connection as an event stream, using the
Server Sent Events <xref target="W3C.CR-eventsource-20121211"/> transport strategy.
</t>
<t>
The server MAY support query parameters for a GET method on this
resource. These parameters are specific to each notification stream.
</t>
<t>
For example:
</t>
<t>
The client might send the following request:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/ietf-restconf-monitoring:restconf-state/
streams/stream=NETCONF/access=xml/location HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might send the following response:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Content-Type: application/yang.api+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<location
xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring">
https://example.com/streams/NETCONF
</location>
]]></artwork>
</figure>
<t>
The RESTCONF client can then use this URL value to start
monitoring the event stream:
</t>
<figure>
<artwork><![CDATA[
GET /streams/NETCONF HTTP/1.1
Host: example.com
Accept: text/event-stream
Cache-Control: no-cache
Connection: keep-alive
]]></artwork>
</figure>
<t>
A RESTCONF client MAY request the server compress the events using
the HTTP header field "Accept‑Encoding". For instance:
</t>
<figure>
<artwork><![CDATA[
GET /streams/NETCONF HTTP/1.1
Host: example.com
Accept: text/event-stream
Cache-Control: no-cache
Connection: keep-alive
Accept-Encoding: gzip, deflate
]]></artwork>
</figure>
<section title="NETCONF Event Stream">
<t>
The server SHOULD support the "NETCONF" notification stream
defined in <xref target="RFC5277"/>. For this stream,
RESTCONF notification subscription requests MAY specify parameters
indicating the events it wishes to receive. These query parameters
are optional to implement, and only available if the server supports
them.
</t>
<?rfc compact="yes"?><texttable title="NETCONF Stream Query Parameters">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>Section</ttcol>
<ttcol align='left'>Description</ttcol>
<c>start-time</c>
<c><xref format="counter" target="start-time"/></c>
<c>replay event start time</c>
<c>stop-time</c>
<c><xref format="counter" target="stop-time"/></c>
<c>replay event stop time</c>
<c>filter</c>
<c><xref format="counter" target="filter"/></c>
<c>boolean content filter</c>
</texttable>
<?rfc compact="no"?> <t>
The semantics and syntax for these query parameters are
defined in the sections listed above. The YANG definition
MUST be converted to a URI-encoded string for use in the request URI.
</t>
<t>
Refer to <xref target="ex-filters"/> for filter parameter examples.
</t>
</section>
</section>
<section title="Receiving Event Notifications">
<t>
RESTCONF notifications are encoded according to the
definition of the event stream. The NETCONF stream
defined in <xref target="RFC5277"/> is encoded in XML format.
</t>
<t>
The structure of the event data is based on the "notification"
element definition in Section 4 of <xref target="RFC5277"/>.
It MUST conform to the schema for the "notification" element
in Section 4 of <xref target="RFC5277"/>, except the XML namespace for
this element is defined as:
</t>
<figure>
<artwork><![CDATA[
urn:ietf:params:xml:ns:yang:ietf-restconf
]]></artwork>
</figure>
<t>
For JSON encoding purposes, the module name for
the "notification" element is "ietf‑restconf".
</t>
<t>
Two child nodes within the "notification" container
are expected, representing the event time and
the event payload. The "event‑time" node is
defined within the "ietf‑restconf" module namespace.
The name and namespace of the payload element are determined
by the YANG module containing the notification-stmt.
</t>
<t>
In the following example, the YANG module "example‑mod"
is used:
</t>
<figure>
<artwork><![CDATA[
module example-mod {
namespace "http://example.com/event/1.0";
prefix ex;
notification event {
leaf event-class { type string; }
container reporting-entity {
leaf card { type string; }
}
leaf severity { type string; }
}
}
]]></artwork>
</figure>
<t>
An example SSE event notification encoded using XML:
</t>
<figure>
<artwork><![CDATA[
data: <notification
data: xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">
data: <event-time>2013-12-21T00:01:00Z</event-time>
data: <event xmlns="http://example.com/event/1.0">
data: <event-class>fault</event-class>
data: <reporting-entity>
data: <card>Ethernet0</card>
data: </reporting-entity>
data: <severity>major</severity>
data: </event>
data: </notification>
]]></artwork>
</figure>
<t>
An example SSE event notification encoded using JSON:
</t>
<figure>
<artwork><![CDATA[
data: {
data: "ietf-restconf:notification": {
data: "event-time": "2013-12-21T00:01:00Z",
data: "example-mod:event": {
data: "event-class": "fault",
data: "reporting-entity": { "card": "Ethernet0" },
data: "severity": "major"
data: }
data: }
data: }
]]></artwork>
</figure>
<t>
Alternatively, since neither XML nor JSON are whitespace sensitive,
the above messages can be encoded onto a single line. For example:
</t>
<t>
For example: ('\' line wrapping added for formatting only)
</t>
<figure>
<artwork><![CDATA[
XML:
data: <notification xmlns="urn:ietf:params:xml:ns:yang:ietf-rest\
conf"><event-time>2013-12-21T00:01:00Z</event-time><event xmlns="\
http://example.com/event/1.0"><event-class>fault</event-class><re\
portingEntity><card>Ethernet0</card></reporting-entity><severity>\
major</severity></event></notification>
JSON:
data: {"ietf-restconf:notification":{"event-time":"2013-12-21\
T00:01:00Z","example-mod:event":{"event-class": "fault","repor\
tingEntity":{"card":"Ethernet0"},"severity":"major"}}}
]]></artwork>
</figure>
<t>
The SSE specifications supports the following additional fields:
event, id and retry. A RESTCONF server MAY send the "retry" field
and, if it does, RESTCONF clients SHOULD use it.
A RESTCONF server SHOULD NOT send the "event" or "id" fields,
as there are no meaningful values that could be used for them
that would not be redundant to the contents of the notification itself.
RESTCONF servers that do not send the "id" field also do not need
to support the HTTP header "Last‑Event‑Id". RESTCONF servers that
do send the "id" field MUST still support the "startTime" query
parameter as the preferred means for a client to specify where to
restart the event stream.
</t>
</section>
</section>
<section title="Error Reporting" anchor="error-reporting">
<t>
HTTP status-lines are used to report success or failure
for RESTCONF operations.
The <rpc‑error> element returned in NETCONF error responses
contains some useful information. This error information
is adapted for use in RESTCONF, and error information
is returned for "4xx" class of status codes.
</t>
<t>
The following table summarizes the return status codes
used specifically by RESTCONF operations:
</t>
<?rfc compact="yes"?><texttable title="HTTP Status Codes used in RESTCONF">
<ttcol align='left'> Status-Line</ttcol>
<ttcol align='left'>Description</ttcol>
<c>100 Continue</c>
<c>POST accepted, 201 should follow</c>
<c>200 OK</c>
<c>Success with response message-body</c>
<c>201 Created</c>
<c>POST to create a resource success</c>
<c>204 No Content</c>
<c>Success without response message-body</c>
<c>304 Not Modified</c>
<c>Conditional operation not done</c>
<c>400 Bad Request</c>
<c>Invalid request message</c>
<c>401 Unauthorized</c>
<c>Client cannot be authenticated</c>
<c>403 Forbidden</c>
<c>Access to resource denied</c>
<c>404 Not Found</c>
<c>Resource target or resource node not found</c>
<c>405 Method Not Allowed</c>
<c>Method not allowed for target resource</c>
<c>409 Conflict</c>
<c>Resource or lock in use</c>
<c>412 Precondition Failed</c>
<c>Conditional method is false</c>
<c>413 Request Entity Too Large</c>
<c>too-big error</c>
<c>414 Request-URI Too Large</c>
<c>too-big error</c>
<c>415 Unsupported Media Type</c>
<c>non RESTCONF media type</c>
<c>500 Internal Server Error</c>
<c>operation-failed</c>
<c>501 Not Implemented</c>
<c>unknown-operation</c>
<c>503 Service Unavailable</c>
<c>Recoverable server error</c>
</texttable>
<?rfc compact="no"?> <t>
Since an operation resource is defined with a YANG "rpc"
statement, and an action is defined with a YANG "action" statement,
a mapping between the NETCONF <error‑tag> value
and the HTTP status code is needed. The specific error
condition and response code to use are data-model specific
and might be contained in the YANG "description" statement
for the "action" or "rpc" statement.
</t>
<?rfc compact="yes"?><texttable title="Mapping from error-tag to status code">
<ttcol align='left'> <error‑tag></ttcol>
<ttcol align='left'>status code</ttcol>
<c>in-use</c>
<c>409</c>
<c>invalid-value</c>
<c>400</c>
<c>too-big</c>
<c>413</c>
<c>missing-attribute</c>
<c>400</c>
<c>bad-attribute</c>
<c>400</c>
<c>unknown-attribute</c>
<c>400</c>
<c>bad-element</c>
<c>400</c>
<c>unknown-element</c>
<c>400</c>
<c>unknown-namespace</c>
<c>400</c>
<c>access-denied</c>
<c>403</c>
<c>lock-denied</c>
<c>409</c>
<c>resource-denied</c>
<c>409</c>
<c>rollback-failed</c>
<c>500</c>
<c>data-exists</c>
<c>409</c>
<c>data-missing</c>
<c>409</c>
<c>operation-not-supported</c>
<c>501</c>
<c>operation-failed</c>
<c>500</c>
<c>partial-operation</c>
<c>500</c>
<c>malformed-message</c>
<c>400</c>
</texttable>
<?rfc compact="no"?><section title="Error Response Message" anchor="errors">
<t>
When an error occurs for a request message on any resource
type, and a "4xx" class of status codes
will be returned (except for status code "403 Forbidden"),
then the server SHOULD send a response message-body containing
the information described by the "errors" container definition
within the YANG module <xref target="module"/>. The Content-Type of this
response message MUST be a subtype of application/yang.errors (see example
below).
</t>
<t>
The client SHOULD specify the desired encoding for error messages
by specifying the appropriate media-type in the Accept header.
If no error media is specified, then the media subtype (e.g., XML or JSON)
of the request message SHOULD be used, or the server MAY choose
any supported message encoding format. If there is no request message
the server MUST select "application/yang.errors+xml"
or "application/yang.errors+json", depending on server preference.
All of the examples
in this document, except for the one below, assume
that XML encoding will be returned if there is an error.
</t>
<t>
YANG Tree Diagram for <errors> data:
</t>
<figure>
<artwork><![CDATA[
+--ro errors
+--ro error*
+--ro error-type enumeration
+--ro error-tag string
+--ro error-app-tag? string
+--ro error-path? instance-identifier
+--ro error-message? string
+--ro error-info
]]></artwork>
</figure>
<t>
The semantics and syntax for RESTCONF error messages are
defined in the "application/yang.errors" restconf-media-type
extension in <xref target="module"/>.
</t>
<t>
Examples:
</t>
<t>
The following example shows an error returned for
an "lock‑denied" error that can occur if a NETCONF
client has locked a datastore. The RESTCONF client
is attempting to delete a data resource. Note that
an Accept header is used to specify the desired
encoding for the error message. No response
message-body content is expected by the client
in this example.
</t>
<figure>
<artwork><![CDATA[
DELETE /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1
Host: example.com
Accept: application/yang.errors+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 409 Conflict
Date: Mon, 23 Apr 2012 17:11:00 GMT
Server: example-server
Content-Type: application/yang.errors+json
{
"ietf-restconf:errors": {
"error": [
{
"error-type": "protocol",
"error-tag": "lock-denied",
"error-message": "Lock failed, lock already held"
}
]
}
}
]]></artwork>
</figure>
<t>
The following example shows an error returned for
a "data‑exists" error on a data resource.
The "jukebox" resource already exists so it cannot be created.
</t>
<t>
The client might send:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-jukebox:jukebox HTTP/1.1
Host: example.com
]]></artwork>
</figure>
<t>
The server might respond (some lines wrapped for display purposes):
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 409 Conflict
Date: Mon, 23 Apr 2012 17:11:00 GMT
Server: example-server
Content-Type: application/yang.errors+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">
<error>
<error-type>protocol</error-type>
<error-tag>data-exists</error-tag>
<error-path
xmlns:rc="urn:ietf:params:xml:ns:yang:ietf-restconf"
xmlns:jbox="https://example.com/ns/example-jukebox">
/rc:restconf/rc:data/jbox:jukebox
</error-path>
<error-message>
Data already exists, cannot create new resource
</error-message>
</error>
</errors>
]]></artwork>
</figure>
</section>
</section>
<section title="RESTCONF module" anchor="module">
<t>
The "ietf‑restconf" module defines conceptual definitions
within an extension and two groupings, which are
not meant to be implemented as datastore contents by a server.
E.g., the "restconf" container is not intended to be implemented
as a top-level data node (under the "/restconf/data" entry point).
</t>
<t>
RFC Ed.: update the date below with the date of RFC publication and
remove this note.
</t>
<t><CODE BEGINS> file "ietf-restconf@2016-03-16.yang"</t>
<figure>
<artwork><![CDATA[
module ietf-restconf {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf";
prefix "rc";
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
WG Chair: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Andy Bierman
<mailto:andy@yumaworks.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>
Editor: Kent Watsen
<mailto:kwatsen@juniper.net>";
description
"This module contains conceptual YANG specifications
for basic RESTCONF media type definitions used in
RESTCONF protocol messages.
Note that the YANG definitions within this module do not
represent configuration data of any kind.
The 'restconf-media-type' YANG extension statement
provides a normative syntax for XML and JSON message
encoding purposes.
Copyright (c) 2016 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this
// note.
// RFC Ed.: remove this note
// Note: extracted from draft-ietf-netconf-restconf-13.txt
// RFC Ed.: update the date below with the date of RFC publication
// and remove this note.
revision 2016-03-16 {
description
"Initial revision.";
reference
"RFC XXXX: RESTCONF Protocol.";
}
extension restconf-media-type {
argument media-type-id {
yin-element true;
}
// RFC Ed.: replace draft-ietf-netmod-yang-json with RFC number
// in the description below, and remove this note.
description
"This extension is used to specify a YANG data structure which
represents a conceptual RESTCONF media type.
Data definition statements within this extension specify
the generic syntax for the specific media type.
YANG is mapped to specific encoding formats outside the
scope of this extension statement. RFC 6020 defines XML
encoding rules for all RESTCONF media types that use
the '+xml' suffix. draft-ietf-netmod-yang-json defines
JSON encoding rules for all RESTCONF media types that
use the '+json' suffix.
The 'media-type-id' parameter value identifies the media type
that is being defined. It contains the string associated
with the generic media type, i.e., no suffix is specified.
This extension is ignored unless it appears as a top-level
statement. It SHOULD contain data definition statements
that result in exactly one container data node definition.
This allows compliant translation to an XML instance
document for each media type.
The module name and namespace value for the YANG module using
the extension statement is assigned to instance document data
conforming to the data definition statements within
this extension.
The sub-statements of this extension MUST follow the
'data-def-stmt' rule in the YANG ABNF.
The XPath document root is the extension statement itself,
such that the child nodes of the document root are
represented by the data-def-stmt sub-statements within
this extension. This conceptual document is the context
for the following YANG statements:
- must-stmt
- when-stmt
- path-stmt
- min-elements-stmt
- max-elements-stmt
- mandatory-stmt
- unique-stmt
- ordered-by
- instance-identifier data type
The following data-def-stmt sub-statements have special
meaning when used within a restconf-resource extension
statement.
- The list-stmt is not required to have a key-stmt defined.
- The if-feature-stmt is ignored if present.
- The config-stmt is ignored if present.
- The available identity values for any 'identityref'
leaf or leaf-list nodes is limited to the module
containing this extension statement, and the modules
imported into that module.
";
}
rc:restconf-media-type "application/yang.errors" {
uses errors;
}
rc:restconf-media-type "application/yang.api" {
uses restconf;
}
grouping errors {
description
"A grouping that contains a YANG container
representing the syntax and semantics of a
YANG Patch errors report within a response message.";
container errors {
description
"Represents an error report returned by the server if
a request results in an error.";
list error {
description
"An entry containing information about one
specific error that occurred while processing
a RESTCONF request.";
reference "RFC 6241, Section 4.3";
leaf error-type {
type enumeration {
enum transport {
description "The transport layer";
}
enum rpc {
description "The rpc or notification layer";
}
enum protocol {
description "The protocol operation layer";
}
enum application {
description "The server application layer";
}
}
mandatory true;
description
"The protocol layer where the error occurred.";
}
leaf error-tag {
type string;
mandatory true;
description
"The enumerated error tag.";
}
leaf error-app-tag {
type string;
description
"The application-specific error tag.";
}
leaf error-path {
type instance-identifier;
description
"The YANG instance identifier associated
with the error node.";
}
leaf error-message {
type string;
description
"A message describing the error.";
}
anydata error-info {
description
"This anydata value MUST represent a container with
zero or more data nodes representing additional
error information.";
}
}
}
}
grouping restconf {
description
"Conceptual container representing the
application/yang.api resource type.";
container restconf {
description
"Conceptual container representing the
application/yang.api resource type.";
container data {
description
"Container representing the application/yang.datastore
resource type. Represents the conceptual root of all
state data and configuration data supported by
the server. The child nodes of this container can be
any data resource (application/yang.data), which are
defined as top-level data nodes from the YANG modules
advertised by the server in the ietf-restconf-monitoring
module.";
}
container operations {
description
"Container for all operation resources
(application/yang.operation),
Each resource is represented as an empty leaf with the
name of the RPC operation from the YANG rpc statement.
E.g.;
POST /restconf/operations/show-log-errors
leaf show-log-errors {
type empty;
}
";
}
leaf yang-library-version {
type string {
pattern '\d{4}-\d{2}-\d{2}';
}
config false;
mandatory true;
description
"Identifies the revision date of the ietf-yang-library
module that is implemented by this RESTCONF server.
Indicates the year, month, and day in YYYY-MM-DD
numeric format.";
}
}
}
}
]]></artwork>
</figure>
<t><CODE ENDS></t>
</section>
<section title="RESTCONF Monitoring">
<t>
The "ietf‑restconf‑monitoring" module provides information about
the RESTCONF protocol capabilities and event notification streams
available from the server. A RESTCONF server MUST implement
the "/restconf‑state/capabilities" container in this module.
</t>
<t>
YANG Tree Diagram for "ietf‑restconf‑monitoring" module:
</t>
<figure>
<artwork><![CDATA[
+--ro restconf-state
+--ro capabilities
| +--ro capability* inet:uri
+--ro streams
+--ro stream* [name]
+--ro name string
+--ro description? string
+--ro replay-support? boolean
+--ro replay-log-creation-time? yang:date-and-time
+--ro access* [encoding]
+--ro encoding string
+--ro location inet:uri
]]></artwork>
</figure>
<section title="restconf-state/capabilities">
<t>
This mandatory container holds the RESTCONF
protocol capability URIs supported by the server.
</t>
<t>
The server MUST maintain a last-modified timestamp for this
container, and return the "Last‑Modified" header when this
data node is retrieved with the GET or HEAD methods.
</t>
<t>
The server SHOULD maintain an entity-tag for this
container, and return the "ETag" header when this
data node is retrieved with the GET or HEAD methods.
</t>
<t>
The server MUST include a "capability" URI leaf-list entry for
the "defaults" mode used by the server, defined in <xref target="defaults-uri"/>.
</t>
<t>
The server MUST include a "capability" URI leaf-list entry identifying
each supported optional protocol feature. This includes optional
query parameters and MAY include other capability URIs defined
outside this document.
</t>
<section title="Query Parameter URIs" anchor="query-parameter-uri">
<t>
A new set of RESTCONF Capability URIs are defined to identify the specific
query parameters (defined in <xref target="query-parameters"/>)
supported by the server.
</t>
<t>
The server MUST include a "capability" leaf-list entry for each
optional query parameter that it supports.
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Query Parameter URIs">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>Section</ttcol>
<ttcol align='left'>URI</ttcol>
<c>depth</c>
<c><xref format="counter" target="depth"/></c>
<c>urn:ietf:params:restconf:capability:depth:1.0</c>
<c>fields</c>
<c><xref format="counter" target="fields"/></c>
<c>urn:ietf:params:restconf:capability:fields:1.0</c>
<c>filter</c>
<c><xref format="counter" target="filter"/></c>
<c>urn:ietf:params:restconf:capability:filter:1.0</c>
<c>replay</c>
<c><xref format="counter" target="start-time"/> <xref format="counter" target="stop-time"/></c>
<c>urn:ietf:params:restconf:capability:replay:1.0</c>
<c>with-defaults</c>
<c><xref format="counter" target="with-defaults"/></c>
<c>urn:ietf:params:restconf:capability:with-defaults:1.0</c>
</texttable>
<?rfc compact="no"?></section>
<section title="The "defaults" Protocol Capability URI" anchor="defaults-uri">
<t>
This URI identifies the defaults handling mode that is used by the
server for processing default leafs in requests for data resources.
A parameter named "basic‑mode" is required for this capability URI.
The "basic‑mode" definitions are specified in the "With-Defaults
Capability for NETCONF" <xref target="RFC6243"/>.
</t>
<?rfc compact="yes"?><texttable title="RESTCONF defaults capability URI">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>URI</ttcol>
<c>defaults</c>
<c>urn:ietf:params:restconf:capability:defaults:1.0</c>
</texttable>
<?rfc compact="no"?> <t>
This protocol capability URI MUST be supported by the server, and
MUST be listed in the "capability" leaf-list in <xref target="mon-mod"/>.
</t>
<?rfc compact="yes"?>
<texttable>
<ttcol align='left'>Value</ttcol>
<ttcol align='left'>Description</ttcol>
<c>report-all</c>
<c>No data nodes are considered default</c>
<c>trim</c>
<c>Values set to the YANG default-stmt value are default</c>
<c>explicit</c>
<c>Values set by the client are never considered default</c>
</texttable>
<?rfc compact="no"?>
<t>
If the "basic‑mode" is set to "report‑all" then the server MUST
adhere to the defaults handling behavior defined in
Section 2.1 of <xref target="RFC6243"/>.
</t>
<t>
If the "basic‑mode" is set to "trim" then the server MUST
adhere to the defaults handling behavior defined in
Section 2.2 of <xref target="RFC6243"/>.
</t>
<t>
If the "basic‑mode" is set to "explicit" then the server MUST
adhere to the defaults handling behavior defined in
Section 2.3 of <xref target="RFC6243"/>.
</t>
<t>
Example: (split for display purposes only)
</t>
<figure>
<artwork><![CDATA[
urn:ietf:params:restconf:capability:defaults:1.0?
basic-mode=explicit
]]></artwork>
</figure>
</section>
</section>
<section title="restconf-state/streams">
<t>
This optional container provides access to the
event notification streams supported by the server.
The server MAY omit this container if no
event notification streams are supported.
</t>
<t>
The server will populate this container with a stream list entry for
each stream type it supports. Each stream contains a leaf
called "events" which contains a URI that
represents an event stream resource.
</t>
<t>
Stream resources are defined in <xref target="stream-resource"/>.
Notifications are defined in <xref target="notifications"/>.
</t>
</section>
<section title="RESTCONF Monitoring Module" anchor="mon-mod">
<t>
The "ietf‑restconf‑monitoring" module defines monitoring
information for the RESTCONF protocol.
</t>
<t>
The "ietf‑yang‑types" and "ietf‑inet‑types" modules from <xref target="RFC6991"/>
are used by this module for some type definitions.
</t>
<t>
RFC Ed.: update the date below with the date of RFC publication and
remove this note.
</t>
<t><CODE BEGINS> file "ietf-restconf-monitoring@2016-03-16.yang"</t>
<figure>
<artwork><![CDATA[
module ietf-restconf-monitoring {
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring";
prefix "rcmon";
import ietf-yang-types { prefix yang; }
import ietf-inet-types { prefix inet; }
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
WG Chair: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Andy Bierman
<mailto:andy@yumaworks.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>
Editor: Kent Watsen
<mailto:kwatsen@juniper.net>";
description
"This module contains monitoring information for the
RESTCONF protocol.
Copyright (c) 2016 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this
// note.
// RFC Ed.: remove this note
// Note: extracted from draft-ietf-netconf-restconf-13.txt
// RFC Ed.: update the date below with the date of RFC publication
// and remove this note.
revision 2016-03-16 {
description
"Initial revision.";
reference
"RFC XXXX: RESTCONF Protocol.";
}
container restconf-state {
config false;
description
"Contains RESTCONF protocol monitoring information.";
container capabilities {
description
"Contains a list of protocol capability URIs";
leaf-list capability {
type inet:uri;
description "A RESTCONF protocol capability URI.";
}
}
container streams {
description
"Container representing the notification event streams
supported by the server.";
reference
"RFC 5277, Section 3.4, <streams> element.";
list stream {
key name;
description
"Each entry describes an event stream supported by
the server.";
leaf name {
type string;
description "The stream name";
reference "RFC 5277, Section 3.4, <name> element.";
}
leaf description {
type string;
description "Description of stream content";
reference
"RFC 5277, Section 3.4, <description> element.";
}
leaf replay-support {
type boolean;
description
"Indicates if replay buffer supported for this stream.
If 'true', then the server MUST support the 'start-time'
and 'stop-time' query parameters for this stream.";
reference
"RFC 5277, Section 3.4, <replaySupport> element.";
}
leaf replay-log-creation-time {
when "../replay-support" {
description
"Only present if notification replay is supported";
}
type yang:date-and-time;
description
"Indicates the time the replay log for this stream
was created.";
reference
"RFC 5277, Section 3.4, <replayLogCreationTime>
element.";
}
list access {
key encoding;
min-elements 1;
description
"The server will create an entry in this list for each
encoding format that is supported for this stream.
The media type 'application/yang.stream' is expected
for all event streams. This list identifies the
sub-types supported for this stream.";
leaf encoding {
type string;
description
"This is the secondary encoding format within the
'text/event-stream' encoding used by all streams.
The type 'xml' is supported for the media type
'application/yang.stream+xml'. The type 'json'
is supported for the media type
'application/yang.stream+json'.";
}
leaf location {
type inet:uri;
mandatory true;
description
"Contains a URL that represents the entry point
for establishing notification delivery via server
sent events.";
}
}
}
}
}
}
]]></artwork>
</figure>
<t><CODE ENDS></t>
</section>
</section>
<section title="YANG Module Library">
<t>
The "ietf‑yang‑library" module defined in <xref target="I-D.ietf-netconf-yang-library"/>
provides information about
the YANG modules and submodules used by the RESTCONF server.
Implementation is mandatory for RESTCONF servers.
All YANG modules and submodules used by the server MUST
be identified in the YANG module library.
</t>
<section title="modules">
<t>
This mandatory container holds the identifiers
for the YANG data model modules supported by the server.
</t>
<t>
The server MUST maintain a last-modified timestamp for this
container, and return the "Last‑Modified" header when this
data node is retrieved with the GET or HEAD methods.
</t>
<t>
The server SHOULD maintain an entity-tag for this
container, and return the "ETag" header when this
data node is retrieved with the GET or HEAD methods.
</t>
<section title="modules/module">
<t>
This mandatory list contains one entry
for each YANG data model module supported by the server.
There MUST be an instance of this list for every
YANG module that is used by the server.
</t>
<t>
The contents of this list are defined in
the "module" YANG list statement in <xref target="I-D.ietf-netconf-yang-library"/>.
</t>
<t>
The server SHOULD maintain a last-modified timestamp for
each instance of this list entry, and return the
"Last‑Modified" header when this data node is retrieved
with the GET or HEAD methods.
</t>
<t>
The server SHOULD maintain an entity-tag for each instance
of this list entry, and return the "ETag" header when this
data node is retrieved with the GET or HEAD methods.
</t>
</section>
</section>
</section>
<section title="IANA Considerations" anchor="iana">
<section title="The "restconf" Relation Type">
<t>
This specification registers the "restconf" relation type in the Link
Relation Type Registry defined by <xref target="RFC5988"/>:
</t>
<figure>
<artwork><![CDATA[
Relation Name: restconf
Description: Identifies the root of RESTCONF API as configured
on this HTTP server. The "restconf" relation
defines the root of the API defined in RFCXXXX.
Subsequent revisions of RESTCONF will use alternate
relation values to support protocol versioning.
Reference: RFCXXXX
]]></artwork>
</figure>
<t>
`
</t>
</section>
<section title="YANG Module Registry">
<t>
This document registers two URIs in the IETF XML registry
<xref target="RFC3688"/>. Following the format in RFC 3688, the following
registration is requested to be made.
</t>
<figure>
<artwork><![CDATA[
URI: urn:ietf:params:xml:ns:yang:ietf-restconf
Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring
Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
]]></artwork>
</figure>
<t>
This document registers two YANG modules in the YANG Module Names
registry <xref target="RFC6020"/>.
</t>
<figure>
<artwork><![CDATA[
name: ietf-restconf
namespace: urn:ietf:params:xml:ns:yang:ietf-restconf
prefix: rc
// RFC Ed.: replace XXXX with RFC number and remove this note
reference: RFCXXXX
name: ietf-restconf-monitoring
namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring
prefix: rcmon
// RFC Ed.: replace XXXX with RFC number and remove this note
reference: RFCXXXX
]]></artwork>
</figure>
</section>
<section title="application/yang Media Sub Types">
<t>
The parent MIME media type for RESTCONF resources is application/yang,
which is defined in <xref target="RFC6020"/>. This document defines the following
sub-types for this media type.
</t>
<figure>
<artwork><![CDATA[
- api
- data
- datastore
- errors
- operation
- stream
Type name: application
Subtype name: yang.xxx, where "xxx" is 1 of "api",
"data", "datastore", "errors", "operation", or "stream"
Required parameters: none
Optional parameters: See section 4.8 in RFC XXXX
Encoding considerations: 8-bit
Security considerations: See Section 12 in RFC XXXX
Interoperability considerations: none
// RFC Ed.: replace XXXX with RFC number and remove this note
Published specification: RFC XXXX
]]></artwork>
</figure>
</section>
<section title="RESTCONF Capability URNs">
<figure>
<artwork><![CDATA[
[Note to RFC Editor:
The RESTCONF Protocol Capability Registry does not yet exist;
Need to ask IANA to create it; remove this note for publication
]
]]></artwork>
</figure>
<t>
This document defines a registry for RESTCONF capability identifiers.
The name of the registry is "RESTCONF Capability URNs".
The review policy for this registry is "IETF Review".
The registry shall record for each entry:
</t>
<t>
<list style="symbols">
<t>
the name of the RESTCONF capability. By convention, this name is
prefixed with the colon ':' character.
</t>
<t>
the URN for the RESTCONF capability.
</t>
</list>
</t>
<t>
This document registers several capability identifiers in
"RESTCONF Capability URNs" registry:
</t>
<figure>
<artwork><![CDATA[
Index
Capability Identifier
------------------------
:defaults
urn:ietf:params:restconf:capability:defaults:1.0
:depth
urn:ietf:params:restconf:capability:depth:1.0
:fields
urn:ietf:params:restconf:capability:fields:1.0
:filter
urn:ietf:params:restconf:capability:filter:1.0
:replay
urn:ietf:params:restconf:capability:replay:1.0
:with-defaults
urn:ietf:params:restconf:capability:with-defaults:1.0
]]></artwork>
</figure>
</section>
</section>
<section title="Security Considerations">
<t>
This section provides security considerations for the resources
defined by the RESTCONF protocol. Security considerations for
HTTPS are defined in <xref target="RFC7230"/>. RESTCONF does not specify
which YANG modules a server needs to support.
Security considerations for the
YANG-defined content manipulated by RESTCONF can be found in the documents
defining those YANG modules.
</t>
<t>
This document does not require use of a specific client authentication
mechanism or authorization model, but it does require that a client
authentication mechanism and authorization model is used whenever a
client accesses a protected resource. Client authentication MUST be
implemented using client certificates or MUST be implemented using an
HTTP authentication scheme. Client authorization MAY be configured
using the NETCONF Access Control Model (NACM) <xref target="RFC6536"/>.
</t>
<t>
Configuration information is by its very nature sensitive. Its
transmission in the clear and without integrity checking leaves
devices open to classic eavesdropping and false data injection
attacks. Configuration information often contains passwords, user
names, service descriptions, and topological information, all of
which are sensitive. Because of this, this protocol SHOULD be
implemented carefully with adequate attention to all manner of attack
one might expect to experience with other management interfaces.
</t>
<t>
Different environments may well allow different rights prior to and
then after authentication. When an operation is not properly authorized,
the RESTCONF server MUST return a "401 Unauthorized" status-line.
Note that authorization information can be exchanged in the form of
configuration information, which is all the more reason to ensure the
security of the connection.
</t>
</section>
<section title="Acknowledgements">
<t>
The authors would like to thank the following people for
their contributions to this document: Ladislav Lhotka,
Juergen Schoenwaelder, Rex Fernando, Robert Wilton,
and Jonathan Hansford.
</t>
<t>
The authors would like to thank the following people for
their excellent review comments and contributions to this document:
Mehmet Ersue, Mahesh Jethanandani, Qin Wu, Joe Clarke, Bert Wijnen,
Ladislav Lhotka, Rodney Cummings, Frank Xialiang, Tom Petch, Robert Sparks,
Balint Uveges, Randy Presuhn, and Sue Hares.
</t>
<t>
Contributions to this material by Andy Bierman are based upon work
supported by the The Space & Terrestrial Communications Directorate
(S&TCD) under Contract No. W15P7T-13-C-A616. Any opinions, findings
and conclusions or recommendations expressed in this material are
those of the author(s) and do not necessarily reflect the views of
The Space & Terrestrial Communications Directorate (S&TCD).
</t>
</section>
</middle>
<back>
<references title="Normative References">
<reference anchor='RFC2046'>
<front>
<title abbrev='Media Types'>Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types</title>
<author initials='N.' surname='Freed' fullname='Ned Freed'>
<organization>Innosoft International, Inc.</organization>
</author>
<author initials='N.' surname='Borenstein' fullname='Nathaniel S. Borenstein'>
<organization>First Virtual Holdings</organization>
</author>
<date year='1996' month='November' />
</front>
<seriesInfo name='RFC' value='2046' />
<format type='TXT' octets='105854' target='http://www.rfc-editor.org/rfc/rfc2046.txt' />
</reference>
<reference anchor="RFC2119">
<front>
<title>Key words for use in RFCs to Indicate Requirement Levels</title>
<author initials="S." surname="Bradner" fullname="S. Bradner">
<organization>Harvard University</organization>
</author>
<date month="March" year="1997"/>
<abstract>
<t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents.</t>
</abstract>
</front>
<seriesInfo name="BCP" value="14"/>
<seriesInfo name="RFC" value="2119"/>
<format type="TXT" octets="4723" target="ftp://ftp.isi.edu/in-notes/rfc2119.txt"/>
</reference>
<!--
<reference anchor="RFC2246">
<front>
<title>The TLS Protocol, Version 1.0</title>
<author initials="T.D" surname="Dierks" fullname="Tim Dierks">
<organization>Certicom</organization>
</author>
<author initials="C.A" surname="Allen" fullname="Christopher Allen">
<organization>Certicom</organization>
</author>
<date month="January" year="1999"/>
<abstract>
<t>This document specifies Version 1.0 of the Transport Layer Security
(TLS) protocol. The TLS protocol provides communications privacy over
the Internet. The protocol allows client/server applications to
communicate in a way that is designed to prevent eavesdropping,
tampering, or message forgery.</t>
</abstract>
</front>
<seriesInfo name="RFC" value="2246"/>
<format type="HTTP" octets="205788" target="http://tools.ietf.org/html/rfc2246"/>
</reference>
-->
<!--
<reference anchor='RFC2396'>
<front>
<title abbrev='URI Generic Syntax'>Uniform Resource Identifiers (URI): Generic Syntax</title>
<author initials='T.' surname='Berners-Lee' fullname='Tim Berners-Lee'>
<organization abbrev='MIT/LCS'>World Wide Web Consortium</organization>
<address>
<postal>
<street>MIT Laboratory for Computer Science, NE43-356</street>
<street>545 Technology Square</street>
<city>Cambridge</city>
<region>MA</region>
<code>02139</code></postal>
<facsimile>+1(617)258-8682</facsimile>
<email>timbl@w3.org</email></address></author>
<author initials='R.T.' surname='Fielding' fullname='Roy T. Fielding'>
<organization abbrev='U.C. Irvine'>Department of Information and Computer Science</organization>
<address>
<postal>
<street>University of California, Irvine</street>
<city>Irvine</city>
<region>CA</region>
<code>92697-3425</code></postal>
<facsimile>+1(949)824-1715</facsimile>
<email>fielding@ics.uci.edu</email></address></author>
<author initials='L.' surname='Masinter' fullname='Larry Masinter'>
<organization abbrev='Xerox Corporation'>Xerox PARC</organization>
<address>
<postal>
<street>3333 Coyote Hill Road</street>
<city>Palo Alto</city>
<region>CA</region>
<code>94034</code></postal>
<facsimile>+1(415)812-4333</facsimile>
<email>masinter@parc.xerox.com</email></address></author>
<date year='1998' month='August' />
<area>Applications</area>
<keyword>uniform resource</keyword>
<keyword>URI</keyword>
<abstract>
<t>
A Uniform Resource Identifier (URI) is a compact string of characters
for identifying an abstract or physical resource. This document
defines the generic syntax of URI, including both absolute and
relative forms, and guidelines for their use; it revises and replaces
the generic definitions in RFC 1738 and RFC 1808.
</t>
<t>
This document defines a grammar that is a superset of all valid URI,
such that an implementation can parse the common components of a URI
reference without knowing the scheme-specific requirements of every
possible identifier type. This document does not define a generative
grammar for URI; that task will be performed by the individual
specifications of each URI scheme.
</t></abstract>
<note title='IESG Note'>
<t>
This paper describes a "superset" of operations that can be applied
to URI. It consists of both a grammar and a description of basic
functionality for URI. To understand what is a valid URI, both the
grammar and the associated description have to be studied. Some of
the functionality described is not applicable to all URI schemes, and
some operations are only possible when certain media types are
retrieved using the URI, regardless of the scheme used.
</t></note></front>
<seriesInfo name='RFC' value='2396' />
<format type='TXT' octets='83639' target='http://www.rfc-editor.org/rfc/rfc2396.txt' />
<format type='HTML' octets='130638' target='http://xml.resource.org/public/rfc/html/rfc2396.html' />
<format type='XML' octets='104983' target='http://xml.resource.org/public/rfc/xml/rfc2396.xml' />
</reference>
-->
<!-- end RFC 2396 -->
<reference anchor='RFC5246'>
<front>
<title>The Transport Layer Security (TLS) Protocol Version 1.2</title>
<author initials='T.' surname='Dierks' fullname='T. Dierks'>
<organization /></author>
<author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
<organization /></author>
<date year='2008' month='August' />
<abstract>
<t>This document specifies Version 1.2 of the Transport Layer Security (TLS) protocol. The TLS protocol provides communications security over the Internet. The protocol allows client/server applications to communicate in a way that is designed to prevent eavesdropping, tampering, or message forgery. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name='RFC' value='5246' />
<format type='TXT' octets='222395' target='http://www.rfc-editor.org/rfc/rfc5246.txt' />
</reference>
<reference anchor='RFC6125'>
<front>
<title>Representation and Verification of Domain-Based Application Service Identity within Internet Public Key Infrastructure Using X.509 (PKIX) Certificates in the Context of Transport Layer Security (TLS)</title>
<author initials='P.' surname='Saint-Andre' fullname='P. Saint-Andre'>
<organization /></author>
<author initials='J.' surname='Hodges' fullname='J. Hodges'>
<organization /></author>
<date year='2011' month='March' />
<abstract>
<t>Many application technologies enable secure communication between two entities by means of Internet Public Key Infrastructure Using X.509 (PKIX) certificates in the context of Transport Layer Security (TLS). This document specifies procedures for representing and verifying the identity of application services in such interactions. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name='RFC' value='6125' />
<format type='TXT' octets='136507' target='http://www.rfc-editor.org/rfc/rfc6125.txt' />
</reference>
<reference anchor='RFC7230'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document provides an overview of HTTP architecture and its associated terminology, defines the "http" and "https" Uniform Resource Identifier (URI) schemes, defines the HTTP/1.1 message syntax and parsing requirements, and describes related security concerns for implementations.</t></abstract></front>
<seriesInfo name='RFC' value='7230' />
<format type='TXT' octets='205947' target='http://www.rfc-editor.org/rfc/rfc7230.txt' />
</reference>
<reference anchor='RFC7231'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless \%application- level protocol for distributed, collaborative, hypertext information systems. This document defines the semantics of HTTP/1.1 messages, as expressed by request methods, request header fields, response status codes, and response header fields, along with the payload of messages (metadata and body content) and mechanisms for content negotiation.</t></abstract></front>
<seriesInfo name='RFC' value='7231' />
<format type='TXT' octets='235053' target='http://www.rfc-editor.org/rfc/rfc7231.txt' />
</reference>
<!--
<reference anchor='RFC2818'>
<front>
<title>HTTP Over TLS</title>
<author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
<organization /></author>
<date year='2000' month='May' />
<abstract>
<t>This memo describes how to use Transport Layer Security (TLS) to secure Hypertext Transfer Protocol (HTTP) connections over the Internet. This memo provides information for the Internet community.</t></abstract></front>
<seriesInfo name='RFC' value='2818' />
<format type='TXT' octets='15170' target='http://www.rfc-editor.org/rfc/rfc2818.txt' />
</reference>
-->
<reference anchor='RFC7232'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypertext information systems. This document defines HTTP/1.1 conditional requests, including metadata header fields for indicating state changes, request header fields for making preconditions on such state, and rules for constructing the responses to a conditional request when one or more preconditions evaluate to false.</t></abstract></front>
<seriesInfo name='RFC' value='7232' />
<format type='TXT' octets='56696' target='http://www.rfc-editor.org/rfc/rfc7232.txt' />
</reference>
<reference anchor='RFC7235'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Authentication</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypermedia information systems. This document defines the HTTP Authentication framework.</t></abstract></front>
<seriesInfo name='RFC' value='7235' />
<format type='TXT' octets='38142' target='http://www.rfc-editor.org/rfc/rfc7235.txt' />
</reference>
<reference anchor='RFC3688'>
<front>
<title>The IETF XML Registry</title>
<author initials='M.' surname='Mealling' fullname='M. Mealling'>
<organization /></author>
<date year='2004' month='January' />
<abstract>
<t>This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas.</t></abstract></front>
<seriesInfo name='BCP' value='81' />
<seriesInfo name='RFC' value='3688' />
<format type='TXT' octets='17325' target='http://www.rfc-editor.org/rfc/rfc3688.txt' />
</reference>
<reference anchor="RFC3986">
<front>
<title abbrev="URI Generic Syntax">Uniform Resource Identifier (URI): Generic Syntax</title>
<author initials="T." surname="Berners-Lee" fullname="Tim Berners-Lee">
<organization abbrev="W3C/MIT">World Wide Web Consortium</organization>
<address>
<postal>
<street>Massachusetts Institute of Technology</street>
<street>77 Massachusetts Avenue</street>
<city>Cambridge</city>
<region>MA</region>
<code>02139</code>
<country>USA</country></postal>
<phone>+1-617-253-5702</phone>
<facsimile>+1-617-258-5999</facsimile>
<email>timbl@w3.org</email>
<uri>http://www.w3.org/People/Berners-Lee/</uri></address></author>
<author initials="R." surname="Fielding" fullname="Roy T. Fielding">
<organization abbrev="Day Software">Day Software</organization>
<address>
<postal>
<street>5251 California Ave., Suite 110</street>
<city>Irvine</city>
<region>CA</region>
<code>92617</code>
<country>USA</country></postal>
<phone>+1-949-679-2960</phone>
<facsimile>+1-949-679-2972</facsimile>
<email>fielding@gbiv.com</email>
<uri>http://roy.gbiv.com/</uri></address></author>
<author initials="L." surname="Masinter" fullname="Larry Masinter">
<organization abbrev="Adobe Systems">Adobe Systems Incorporated</organization>
<address>
<postal>
<street>345 Park Ave</street>
<city>San Jose</city>
<region>CA</region>
<code>95110</code>
<country>USA</country></postal>
<phone>+1-408-536-3024</phone>
<email>LMM@acm.org</email>
<uri>http://larry.masinter.net/</uri></address></author>
<date year="2005" month="January"/>
<area>Applications</area>
<keyword>uniform resource identifier</keyword>
<keyword>URI</keyword>
<keyword>URL</keyword>
<keyword>URN</keyword>
<keyword>WWW</keyword>
<keyword>resource</keyword>
<abstract>
<t>
A Uniform Resource Identifier (URI) is a compact sequence of characters
that identifies an abstract or physical resource. This specification
defines the generic URI syntax and a process for resolving URI references
that might be in relative form, along with guidelines and security
considerations for the use of URIs on the Internet.
The URI syntax defines a grammar that is a superset of all valid URIs,
allowing an implementation to parse the common components of a URI
reference without knowing the scheme-specific requirements of every
possible identifier. This specification does not define a generative
grammar for URIs; that task is performed by the individual
specifications of each URI scheme.
</t></abstract></front>
<seriesInfo name="STD" value="66"/>
<seriesInfo name="RFC" value="3986"/>
<format type="TXT" octets="141811" target="http://www.rfc-editor.org/rfc/rfc3986.txt"/>
<format type="HTML" octets="213584" target="http://xml.resource.org/public/rfc/html/rfc3986.html"/>
<format type="XML" octets="163534" target="http://xml.resource.org/public/rfc/xml/rfc3986.xml"/>
</reference>
<reference anchor='RFC5277'>
<front>
<title>NETCONF Event Notifications</title>
<author initials='S.C.' surname='Chisholm' fullname='S. Chisholm'>
<organization>Nortel</organization>
</author>
<author initials='H.T.' surname='Trevino' fullname='H. Trevino'>
<organization>Cisco</organization>
</author>
<date year='2008' month='July'/>
<abstract>
<t>YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS TRACK]</t>
</abstract>
</front>
<seriesInfo name='RFC' value='5277'/>
<format type="HTML" octets="96192" target="http://tools.ietf.org/html/rfc5277.html"/>
</reference>
<reference anchor='RFC5280'>
<front>
<title>Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile</title>
<author initials='D.C.' surname='Cooper' fullname='David Cooper'>
<organization>NIST</organization>
</author>
<author initials='S.S.' surname='Santesson' fullname='Stefan Santesson'>
<organization>Microsoft</organization>
</author>
<author initials='S.F.' surname='Farrell' fullname='Stephen Farrell'>
<organization>Trinity College Dublin</organization>
</author>
<author initials='S.B.' surname='Boeyen' fullname='Sharon Boeyen'>
<organization>Entrust</organization>
</author>
<author initials='R.H.' surname='Housley' fullname='Russell Housley'>
<organization>Vigil Security</organization>
</author>
<author initials='T.P.' surname='Polk' fullname='Tim Polk'>
<organization>NIST</organization>
</author>
<date year='2008' month='May'/>
<abstract>
<t>This memo profiles the X.509 v3 certificate and X.509 v2 certificate
revocation list (CRL) for use in the Internet. An overview of this
approach and model is provided as an introduction. The X.509 v3
certificate format is described in detail, with additional
information regarding the format and semantics of Internet name
forms. Standard certificate extensions are described and two
Internet-specific extensions are defined. A set of required
certificate extensions is specified. The X.509 v2 CRL format is
described in detail along with standard and Internet-specific
extensions. An algorithm for X.509 certification path validation is
described. An ASN.1 module and examples are provided in the
appendices.</t>
</abstract>
</front>
<seriesInfo name='RFC' value='5280'/>
<format type="HTML" octets="430252" target="http://tools.ietf.org/html/rfc5280"/>
</reference>
<reference anchor="RFC5789">
<front>
<title>PATCH Method for HTTP</title>
<author initials="L." surname="Dusseault" fullname="L. Dusseault">
<organization/></author>
<author initials="J." surname="Snell" fullname="J. Snell">
<organization/></author>
<date year="2010" month="March"/>
<abstract>
<t>Several applications extending the Hypertext Transfer Protocol (HTTP) require a feature to do partial resource modification. The existing HTTP PUT method only allows a complete replacement of a document. This proposal adds a new HTTP method, PATCH, to modify an existing HTTP resource. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name="RFC" value="5789"/>
<format type="TXT" octets="21706" target="http://www.rfc-editor.org/rfc/rfc5789.txt"/>
</reference>
<!--
<reference anchor='RFC5785'>
<front>
<title>Defining Well-Known Uniform Resource Identifiers (URIs)</title>
<author initials='M.' surname='Nottingham' fullname='M. Nottingham'>
<organization /></author>
<author initials='E.' surname='Hammer-Lahav' fullname='E. Hammer-Lahav'>
<organization /></author>
<date year='2010' month='April' />
<abstract>
<t>This memo defines a path prefix for "well-known locations", "/.well-known/", in selected Uniform Resource Identifier (URI) schemes. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name='RFC' value='5785' />
<format type='TXT' octets='13779' target='http://www.rfc-editor.org/rfc/rfc5785.txt' />
</reference>
-->
<reference anchor='RFC5988'>
<front>
<title>Web Linking</title>
<author initials='M.N.' surname='Nottingham' fullname='Mark Nottingham'>
<organization/>
</author>
<date year='2010' month='October'/>
</front>
<seriesInfo name='RFC' value='5988'/>
</reference>
<reference anchor="RFC6020">
<front>
<title>YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)</title>
<author initials="M." surname="Bjorklund" fullname="M. Bjorklund">
<organization/>
</author>
<date year="2010" month="October"/>
<abstract>
<t>YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS TRACK]</t>
</abstract>
</front>
<seriesInfo name="RFC" value="6020"/>
<format type="TXT" octets="324178" target="http://www.rfc-editor.org/rfc/rfc6020.txt"/>
</reference>
<reference anchor="I-D.ietf-netmod-rfc6020bis">
<front>
<title>The YANG 1.1 Data Modeling Language</title>
<author initials="M" surname="Bjorklund" fullname="Martin Bjorklund">
<organization/>
</author>
<date month="February" day="16" year="2016"/>
<abstract>
<t>YANG is a data modeling language used to model configuration data, state data, remote procedure calls, and notifications for network management protocols like the Network Configuration Protocol (NETCONF).</t>
</abstract>
</front>
<seriesInfo name="Internet-Draft" value="draft-ietf-netmod-rfc6020bis-11"/>
<format type="TXT" target="http://www.ietf.org/internet-drafts/draft-ietf-netmod-rfc6020bis-11.txt"/>
</reference>
<reference anchor='RFC6241'>
<front>
<title>Network Configuration Protocol (NETCONF)</title>
<author initials='R.' surname='Enns' fullname='R. Enns' role="editor">
<organization/>
</author>
<author initials='M.' surname='Bjorklund' fullname='M. Bjorklund' role="editor">
<organization/>
</author>
<author initials='J.' surname='Schoenwaelder' fullname='J. Schoenwaelder' role="editor">
<organization/>
</author>
<author initials='A.' surname='Bierman' fullname='A. Bierman' role="editor">
<organization/>
</author>
<date year='2011' month='June'/>
</front>
<seriesInfo name='RFC' value='6241'/>
</reference>
<reference anchor='RFC6243'>
<front>
<title>With-defaults Capability for NETCONF</title>
<author initials='A.' surname='Bierman' fullname='A. Bierman'>
<organization /></author>
<author initials='B.' surname='Lengyel' fullname='B. Lengyel'>
<organization /></author>
<date year='2011' month='June' />
<abstract>
<t>The Network Configuration Protocol (NETCONF) defines ways to read and edit configuration data from a NETCONF server. In some cases, part of this data may not be set by the NETCONF client, but rather a default value known to the server is used instead. In many situations the NETCONF client has a priori knowledge about default data, so the NETCONF server does not need to save it in a NETCONF configuration datastore or send it to the client in a retrieval operation reply. In other situations the NETCONF client will need this data from the server. Not all server implementations treat this default data the same way. This document defines a capability-based extension to the NETCONF protocol that allows the NETCONF client to identify how defaults are processed by the server, and also defines new mechanisms for client control of server processing of default data. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name='RFC' value='6243' />
<format type='TXT' octets='51568' target='http://www.rfc-editor.org/rfc/rfc6243.txt' />
</reference>
<reference anchor="RFC6536">
<front>
<title>Network Configuration Protocol (NETCONF) Access Control Model</title>
<author initials="A." surname="Bierman" fullname="A. Bierman">
<organization/></author>
<author initials="M." surname="Bjorklund" fullname="M. Bjorklund">
<organization/></author>
<date year="2012" month="March"/>
<abstract>
<t>The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF protocol access for particular users to a pre-configured subset of all available NETCONF protocol operations and content. This document defines such an access control model. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name="RFC" value="6536"/>
<format type="TXT" octets="90803" target="http://www.rfc-editor.org/rfc/rfc6536.txt"/>
</reference>
<reference anchor='RFC6570'>
<front>
<title>URI Template</title>
<author initials='J.G.' surname='Gregorio' fullname='Joe Gregorio'>
<organization>Google</organization>
</author>
<author initials='R.F.' surname='Fielding' fullname='Roy Fielding'>
<organization>Adobe</organization>
</author>
<author initials='M.H.' surname='Hadley' fullname='Marc Hadley'>
<organization>MITRE</organization>
</author>
<author initials='M.N.' surname='Nottingham' fullname='Mark Nottingham'>
<organization>Rackspace</organization>
</author>
<author initials='D.O.' surname='Orchard' fullname='David Orchard'>
<organization>Salesforce.com</organization>
</author>
<date year='2012' month='March'/>
</front>
<seriesInfo name='RFC' value='6570'/>
</reference>
<reference anchor="I-D.ietf-netmod-yang-json">
<front>
<title>JSON Encoding of Data Modeled with YANG</title>
<author initials="L." surname="Lhotka" fullname="L. Lhotka">
<organization>CZ.NIC</organization>
</author>
<date year="2015" month="October"/>
</front>
<seriesInfo name="Internet-Draft"
value="draft-ietf-netmod-yang-json-06"/>
<format type='TXT'
target='http://www.ietf.org/id/draft-ietf-netmod-yang-json-06.txt'/>
</reference>
<reference anchor="I-D.ietf-netmod-yang-metadata">
<front>
<title>Defining and Using Metadata with YANG</title>
<author initials="L." surname="Lhotka" fullname="L. Lhotka">
<organization>CZ.NIC</organization>
</author>
<date year="2015" month="September"/>
</front>
<seriesInfo name="Internet-Draft"
value="draft-ietf-netmod-yang-metadata-02"/>
<format type='TXT'
target='http://www.ietf.org/id/draft-ietf-netmod-yang-metadata-02.txt'/>
</reference>
<reference anchor="RFC6415">
<front>
<title>Web Host Metadata</title>
<author initials='E.' surname='Hammer-Lahav' fullname='Eran Hammer-Lahav'><organization /></author>
<author initials='B.C.' surname='Cook' fullname='Blaine Cook'><organization /></author>
<date year='2011' month='October' />
</front>
<seriesInfo name='RFC' value='6415' />
<format type='TXT' octets='32018' target='http://www.rfc-editor.org/rfc/rfc6415.txt' />
</reference>
<reference anchor='RFC6991'>
<front>
<title>Common YANG Data Types</title>
<author initials='J.' surname='Schoenwaelder' fullname='J. Schoenwaelder'>
<organization /></author>
<date year='2013' month='July' />
<abstract>
<t>This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021.</t></abstract></front>
<seriesInfo name='RFC' value='6991' />
<format type='TXT' octets='60242' target='http://www.rfc-editor.org/rfc/rfc6991.txt' />
</reference>
<reference anchor="W3C.CR-eventsource-20121211"
target="http://www.w3.org/TR/2012/CR-eventsource-20121211">
<front>
<title>Server-Sent Events</title>
<author initials="I." surname="Hickson" fullname="Ian Hickson">
<organization/></author><date month="December" day="11" year="2012"/>
</front>
<seriesInfo name="World Wide Web Consortium CR"
value="CR-eventsource-20121211"/>
<format type="HTML"
target="http://www.w3.org/TR/2012/CR-eventsource-20121211"/>
</reference>
<reference anchor='W3C.REC-xml-20081126'
target='http://www.w3.org/TR/2008/REC-xml-20081126'>
<front>
<title>Extensible Markup Language (XML) 1.0 (Fifth Edition)</title>
<author initials='F.' surname='Yergeau' fullname='François Yergeau'>
<organization />
</author>
<author initials='E.' surname='Maler' fullname='Eve Maler'>
<organization />
</author>
<author initials='J.' surname='Paoli' fullname='Jean Paoli'>
<organization />
</author>
<author initials='C.' surname='Sperberg-McQueen' fullname='C. M. Sperberg-McQueen'>
<organization />
</author>
<author initials='T.' surname='Bray' fullname='Tim Bray'>
<organization />
</author>
<date month='November' day='26' year='2008' />
</front>
<seriesInfo name='World Wide Web Consortium Recommendation' value='REC-xml-20081126' />
<format type='HTML' target='http://www.w3.org/TR/2008/REC-xml-20081126' />
</reference>
<reference anchor="W3C.REC-html5-20141028" target="http://www.w3.org/TR/2014/REC-html5-20141028">
<front>
<title>HTML5</title>
<author initials="I." surname="Hickson" fullname="Ian Hickson">
<organization/>
</author>
<author initials="R." surname="Berjon" fullname="Robin Berjon">
<organization/>
</author>
<author initials="S." surname="Faulkner" fullname="Steve Faulkner">
<organization/>
</author>
<author initials="T." surname="Leithead" fullname="Travis Leithead">
<organization/>
</author>
<author initials="E." surname="Navara" fullname="Erika Doyle Navara">
<organization/>
</author>
<author initials="E." surname="O'Connor" fullname="Edward O'Connor">
<organization/>
</author>
<author initials="S." surname="Pfeiffer" fullname="Silvia Pfeiffer">
<organization/>
</author>
<date month="October" day="28" year="2014"/>
</front>
<seriesInfo name="World Wide Web Consortium Recommendation" value="REC-html5-20141028"/>
<format type="HTML" target="http://www.w3.org/TR/2014/REC-html5-20141028"/>
</reference>
<reference anchor="RFC7159" target="http://www.rfc-editor.org/info/rfc7159">
<front>
<title>
The JavaScript Object Notation (JSON) Data Interchange Format
</title>
<author initials="T." surname="Bray" fullname="T. Bray" role="editor">
<organization/>
</author>
<date year="2014" month="March"/>
<abstract>
<t>
JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format. It was derived from the ECMAScript Programming Language Standard. JSON defines a small set of formatting rules for the portable representation of structured data.
</t>
<t>
This document removes inconsistencies with other specifications of JSON, repairs specification errors, and offers experience-based interoperability guidance.
</t>
</abstract>
</front>
<seriesInfo name="RFC" value="7159"/>
<seriesInfo name="DOI" value="10.17487/RFC7159"/>
</reference>
<reference anchor="RFC7320">
<front>
<title>URI Design and Ownership</title>
<author initials="M." surname="Nottingham" fullname="M. Nottingham">
<organization/>
</author>
<date year="2014" month="July"/>
<abstract>
<t>
Section 1.1.1 of RFC 3986 defines URI syntax as "a federated and extensible naming system wherein each scheme's specification may further restrict the syntax and semantics of identifiers using that scheme." In other words, the structure of a URI is defined by its scheme. While it is common for schemes to further delegate their substructure to the URI's owner, publishing independent standards that mandate particular forms of URI substructure is inappropriate, because that essentially usurps ownership. This document further describes this problematic practice and provides some acceptable alternatives for use in standards.
</t>
</abstract>
</front>
<seriesInfo name="BCP" value="190"/>
<seriesInfo name="RFC" value="7320"/>
<format type="TXT" octets="18275" target="http://www.rfc-editor.org/rfc/rfc7320.txt"/>
</reference>
<reference anchor='RFC7589' target='http://www.rfc-editor.org/info/rfc7589'>
<front>
<title>Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication</title>
<author initials='M.' surname='Badra' fullname='M. Badra'><organization /></author>
<author initials='A.' surname='Luchuk' fullname='A. Luchuk'><organization /></author>
<author initials='J.' surname='Schoenwaelder' fullname='J. Schoenwaelder'><organization /></author>
<date year='2015' month='June' />
<abstract><t>The Network Configuration Protocol (NETCONF) provides mechanisms to install, manipulate, and delete the configuration of network devices. This document describes how to use the Transport Layer Security (TLS) protocol with mutual X.509 authentication to secure the exchange of NETCONF messages. This revision of RFC 5539 documents the new message framing used by NETCONF 1.1 and it obsoletes RFC 5539.</t></abstract>
</front>
<seriesInfo name='RFC' value='7589'/>
<seriesInfo name='DOI' value='10.17487/RFC7589'/>
</reference>
<reference anchor="I-D.ietf-netconf-yang-library">
<front>
<title>YANG Module Library</title>
<author initials="A.B." surname="Bierman" fullname="Andy Bierman">
<organization />
</author>
<author initials="M.B." surname="Bjorklund" fullname="Martin Bjorklund">
<organization />
</author>
<author initials="K.W." surname="Watsen" fullname="Kent Watsen">
<organization />
</author>
<date year="2016" month="April"/>
</front>
<seriesInfo name="Internet-Draft" value="draft-ietf-netconf-yang-library-06" />
<format type="TXT" target="https://tools.ietf.org/html/draft-ietf-netconf-yang-library-06"/>
</reference>
<reference anchor="XPath" target="http://www.w3.org/TR/1999/REC-xpath-19991116">
<front>
<title>XML Path Language (XPath) Version 1.0</title>
<author initials="J." surname="Clark" fullname="James Clark">
<organization/>
</author>
<author initials="S." surname="DeRose" fullname="Steven DeRose">
<organization/>
</author>
<date month="November" day="16" year="1999"/>
</front>
<seriesInfo name="World Wide Web Consortium Recommendation" value="REC-xpath-19991116"/>
<format type="HTML" target="http://www.w3.org/TR/1999/REC-xpath-19991116"/>
</reference>
</references>
<references title="Informative References">
<reference anchor="rest-dissertation">
<front>
<title>Architectural Styles and
the Design of Network-based Software Architectures</title>
<author initials='R.F.' surname='Fielding' fullname='Roy Fielding'>
<organization>University of California, Irvine</organization>
</author>
<date year='2000'/>
</front>
</reference>
<reference anchor="I-D.ietf-netconf-yang-patch">
<front>
<title>YANG Patch Media Type</title>
<author initials="A.B." surname="Bierman" fullname="Andy Bierman">
<organization />
</author>
<author initials="M.B." surname="Bjorklund" fullname="Martin Bjorklund">
<organization />
</author>
<author initials="K.W." surname="Watsen" fullname="Kent Watsen">
<organization />
</author>
<date year="2015" month="October"/>
</front>
<seriesInfo name="Internet-Draft" value="draft-ietf-netconf-yang-patch-06" />
<format type="TXT" target="https://tools.ietf.org/html/draft-ietf-netconf-yang-patch-06"/>
</reference>
</references>
<section title="Change Log">
<figure>
<artwork><![CDATA[
-- RFC Ed.: remove this section before publication.
]]></artwork>
</figure>
<t>
The RESTCONF issue tracker can be found here:
https://github.com/netconf-wg/restconf/issues
</t>
<section title="v12 - v13">
<t>
<list style="symbols">
<t>
fix YANG library module examples (now called module-state)
</t>
<t>
fix MUST not term (should be MUST NOT)
</t>
<t>
removed RFC 2818 reference (changed citation to RFC 7230)
</t>
</list>
</t>
</section>
<section title="v11 - v12">
<t>
<list style="symbols">
<t>
clarify query parameter requirements
</t>
<t>
move filter query section to match table order in sec. 4.8
</t>
<t>
clarify that depth default is entire subtree for datastore resource
</t>
<t>
change ietf-restconf to YANG 1.1 to use anydata instead of anyxml
</t>
<t>
made implementation of timestamps optional since ETags are mandatory
</t>
<t>
removed confusing text about data resource definition revision date
</t>
<t>
clarify that errors should be returned for any resource type
</t>
<t>
clarified media subtype (not type) for error response
</t>
<t>
clarified client SHOULD (not MAY) specify errors format in Accept header
</t>
<t>
clarified terminology in many sections
</t>
</list>
</t>
</section>
<section title="v10 - v11">
<t>
<list style="symbols">
<t>
change term 'operational data' to 'state data'
</t>
<t>
clarify :startup behavior
</t>
<t>
clarify X.509 security text
</t>
<t>
change '403 Forbidden' to '401 Unauthorized' for GET error
</t>
<t>
clarify MUST have one "restconf" link relation
</t>
<t>
clarify that NV-storage is not mandatory
</t>
<t>
clarify how "Last‑Modified" and "ETag" header info can be used by a client
</t>
<t>
clarify meaning of mandatory parameter
</t>
<t>
fix module name in action examples
</t>
<t>
clarify operation resource request needs to be known to parse the output
</t>
<t>
clarify ordered-by user terminology
</t>
<t>
fixed JSON example in D.1.1
</t>
</list>
</t>
</section>
<section title="v09 - v10">
<t>
<list style="symbols">
<t>
address review comments: github issue #36
</t>
<t>
removed intro text about no knowledge of NETCONF needed
</t>
<t>
clarified candidate and confirmed-commit behavior in sec. 1.3
</t>
<t>
clarified that a RESTCONF server MUST support TLS
</t>
<t>
clarified choice of 403 or 404 error
</t>
<t>
fixed forward references to URI template (w/reference at first use)
</t>
<t>
added reference to HTML5
</t>
<t>
made error terminology more consistent
</t>
<t>
clarified that only 1 list or leaf-list instance can be returned
in an XML response message-body
</t>
<t>
clarified that more than 1 instance must not be created by
a POST method
</t>
<t>
clarified that PUT cannot be used to change a leaf-list value
or any list key values
</t>
<t>
clarified that PATCH cannot be used to change a leaf-list value
or any list key values
</t>
<t>
clarified that DELETE should not be used to delete more than one instance
of a leaf-list or list
</t>
<t>
update JSON RFC reference
</t>
<t>
specified that leaf-list instances are data resources
</t>
<t>
specified how a leaf-list instance identifier is constructed
</t>
<t>
fixed get-schema example
</t>
<t>
clarified that if no Accept header the server SHOULD return
the type specified in RESTCONF, but MAY return any media-type,
according to HTTP rules
</t>
<t>
clarified that server SHOULD maintain timestamp and etag for data resources
</t>
<t>
clarified default for content query parameter
</t>
<t>
moved terminology section earlier in doc to avoid forward usage
</t>
<t>
clarified intro text wrt/ interactions with NETCONF and access
to specific datastores
</t>
<t>
clarified server implementation requirements for YANG defaults
</t>
<t>
clarified that Errors is not a resource, just a media type
</t>
<t>
clarified that HTTP without TLS MUST NOT be used
</t>
<t>
add RESTCONF Extensibility section to make it clear how
RESTCONF will be extended in the future
</t>
<t>
add text warning that NACM does not work with HTTP caching
</t>
<t>
remove sec. 5.2 Message Headers
</t>
<t>
remove 202 Accepted from list of used status-lines -- not allowed
</t>
<t>
made implementation of OPTIONS MUST instead of SHOULD
</t>
<t>
clarified that successful PUT for altering data returns 204
</t>
<t>
fixed "point" parameter example
</t>
<t>
added example of alternate value for root resource discovery
</t>
<t>
added YANG action examples
</t>
<t>
fixed some JSON examples
</t>
<t>
changed default value for content query parameter to "all"
</t>
<t>
changed empty container JSON encoding from "[null]" to "{}"
</t>
<t>
added mandatory /restconf/yang-library-version leaf to
advertise revision-date of the YANG library implemented by the server
</t>
<t>
clarified URI encoding rules for leaf-list
</t>
<t>
clarified sec. 2.2 wrt/ certificates and TLS
</t>
<t>
added update procedure for entity tag and timestamp
</t>
</list>
</t>
</section>
<section title="v08 - v09">
<t>
<list style="symbols">
<t>
fix introduction text regarding implementation requirements
for the ietf-yang-library
</t>
<t>
clarified HTTP authentication requirements
</t>
<t>
fix host-meta example
</t>
<t>
changed list key encoding to clarify that quoted strings are not allowed.
Percent-encoded values are used if quotes would be required. A missing
key is treated as a zero-length string
</t>
<t>
Fixed example of percent-encoded string to match YANG model
</t>
<t>
Changed streams examples to align with naming already used
</t>
</list>
</t>
</section>
<section title="v07 - v08">
<t>
<list style="symbols">
<t>
add support for YANG 1.1 action statement
</t>
<t>
changed mandatory encoding from XML to XML or JSON
</t>
<t>
fix syntax in fields parameter definition
</t>
<t>
add meta-data encoding examples for XML and JSON
</t>
<t>
remove RFC 2396 references and update with 3986
</t>
<t>
change encoding of a key so quoted string are not used, since
they are already percent-encoded. A zero-length string is
not encoded (/list=foo,,baz)
</t>
<t>
Add example of percent-encoded key value
</t>
</list>
</t>
</section>
<section title="v06 - v07">
<t>
<list style="symbols">
<t>
fixed all issues identified in email from Jernej Tuljak
in netconf email 2015-06-22
</t>
<t>
fixed error example bug where error-urlpath was still used.
Changed to error-path.
</t>
<t>
added mention of YANG Patch and informative reference
</t>
<t>
added support for YANG 1.1, specifically support for anydata and
actions
</t>
<t>
removed the special field value "*", since it is no longer needed
</t>
</list>
</t>
</section>
<section title="v05 - v06">
<t>
<list style="symbols">
<t>
fixed RESTCONF issue #23 (ietf-restconf-monitoring bug)
</t>
</list>
</t>
</section>
<section title="v04 - v05">
<t>
<list style="symbols">
<t>
changed term 'notification event' to 'event notification'
</t>
<t>
removed intro text about framework and meta-model
</t>
<t>
removed early mention of API resources
</t>
<t>
removed term unified datastore and cleaned up text about NETCONF datastores
</t>
<t>
removed text about not immediate persistence of edits
</t>
<t>
removed RESTCONF-specific data-resource-identifier typedef and its usage
</t>
<t>
clarified encoding of key leafs
</t>
<t>
changed several examples from JSON to XML encoding
</t>
<t>
made 'insert' and 'point' query parameters mandatory to implement
</t>
<t>
removed ":insert" capability URI
</t>
<t>
renamed stream/encoding to stream/access
</t>
<t>
renamed stream/encoding/type to stream/access/encoding
</t>
<t>
renamed stream/encoding/events to stream/access/location
</t>
<t>
changed XPath from informative to normative reference
</t>
<t>
changed rest-dissertation from normative to informative reference
</t>
<t>
changed example-jukebox playlist 'id' from a data-resource-identifier
to a leafref pointing at the song name
</t>
</list>
</t>
</section>
<section title="v03 - v04">
<t>
<list style="symbols">
<t>
renamed 'select' to 'fields' (#1)
</t>
<t>
moved collection resource and page capability
to draft-ietf-netconf-restconf-collection-00 (#3)
</t>
<t>
added mandatory "defaults" protocol capability URI (#4)
</t>
<t>
added optional "with‑defaults" query parameter URI (#4)
</t>
<t>
clarified authentication procedure (#9)
</t>
<t>
moved ietf-yang-library module to draft-ietf-netconf-yang-library-00 (#13)
</t>
<t>
clarified that JSON encoding of module name in a URI
MUST follow the netmod-yang-json encoding rules (#14)
</t>
<t>
added restconf-media-type extension (#15)
</t>
<t>
remove "content" query parameter URI and made this
parameter mandatory (#16)
</t>
<t>
clarified datastore usage
</t>
<t>
changed lock-denied error example
</t>
<t>
added with-defaults query parameter example
</t>
<t>
added term "RESTCONF Capability"
</t>
<t>
changed NETCONF Capability URI registry usage to new
RESTCONF Capability URI Registry usage
</t>
</list>
</t>
</section>
<section title="v02 - v03">
<t>
<list style="symbols">
<t>
added collection resource
</t>
<t>
added "page" query parameter capability
</t>
<t>
added "limit" and "offset" query parameters, which are available if
the "page" capability is supported
</t>
<t>
added "stream list" term
</t>
<t>
fixed bugs in some examples
</t>
<t>
added "encoding" list within the "stream" list to allow
different <events> URLs for XML and JSON encoding.
</t>
<t>
made XML MUST implement and JSON MAY implement for servers
</t>
<t>
re-add JSON notification examples (previously removed)
</t>
<t>
updated JSON references
</t>
</list>
</t>
</section>
<section title="v01 - v02">
<t>
<list style="symbols">
<t>
moved query parameter definitions from the YANG module
back to the plain text sections
</t>
<t>
made all query parameters optional to implement
</t>
<t>
defined query parameter capability URI
</t>
<t>
moved 'streams' to new YANG module (ietf-restconf-monitoring)
</t>
<t>
added 'capabilities' container to new YANG module (ietf-restconf-monitoring)
</t>
<t>
moved 'modules' container to new YANG module (ietf-yang-library)
</t>
<t>
added new leaf 'module‑set‑id' (ietf-yang-library)
</t>
<t>
added new leaf 'conformance' (ietf-yang-library)
</t>
<t>
changed 'schema' leaf to type inet:uri that returns the location
of the YANG schema (instead of returning the schema directly)
</t>
<t>
changed 'events' leaf to type inet:uri that returns the location
of the event stream resource (instead of returning events directly)
</t>
<t>
changed examples for yang.api resource since the monitoring information
is no longer in this resource
</t>
<t>
closed issue #1 'select parameter' since no objections to the proposed
syntax
</t>
<t>
closed "encoding of list keys" issue since no objection to new encoding
of list keys in a target resource URI.
</t>
<t>
moved open issues list to the issue tracker on github
</t>
</list>
</t>
</section>
<section title="v00 - v01">
<t>
<list style="symbols">
<t>
fixed content=nonconfig example (non-config was incorrect)
</t>
<t>
closed open issue 'message‑id'. There is no need for a message-id
field, and RFC 2392 does not apply.
</t>
<t>
closed open issue 'server support verification'. The headers used
by RESTCONF are widely supported.
</t>
<t>
removed encoding rules from section on RESTCONF Meta-Data. This is now
defined in "I‑D.lhotka‑netmod‑yang‑json".
</t>
<t>
added media type application/yang.errors to map to errors YANG grouping.
Updated error examples to use new media type.
</t>
<t>
closed open issue 'additional datastores'. Support may be added in the
future to identify new datastores.
</t>
<t>
closed open issue 'PATCH media type discovery'. The section
on PATCH has an added sentence on the Accept-Patch header.
</t>
<t>
closed open issue 'YANG to resource mapping'. Current mapping
of all data nodes to resources will be used in order to allow
mandatory DELETE support. The PATCH operation is optional,
as well as the YANG Patch media type.
</t>
<t>
closed open issue '_self links for HATEOAS support'. It was decided
that they are redundant because they can be derived from the YANG module
for the specific data.
</t>
<t>
added explanatory text for the 'select' parameter.
</t>
<t>
added RESTCONF Path Resolution section for discovering the
root of the RESTCONF API using the /.well-known/host-meta.
</t>
<t>
added an "error" media type to for structured error messages
</t>
<t>
added Secure Transport section requiring TLS
</t>
<t>
added Security Considerations section
</t>
<t>
removed all references to "REST‑like"
</t>
</list>
</t>
</section>
<section title="bierman:restconf-04 to ietf:restconf-00">
<t>
<list style="symbols">
<t>
updated open issues section
</t>
</list>
</t>
</section>
</section>
<section title="Open Issues">
<figure>
<artwork><![CDATA[
-- RFC Ed.: remove this section before publication.
]]></artwork>
</figure>
<t>
The RESTCONF issues are tracked on github.com:
</t>
<figure>
<artwork><![CDATA[
https://github.com/netconf-wg/restconf/issues
]]></artwork>
</figure>
</section>
<section title="Example YANG Module">
<t>
The example YANG module used in this document represents
a simple media jukebox interface.
</t>
<t>
YANG Tree Diagram for "example‑jukebox" Module
</t>
<figure>
<artwork><![CDATA[
+--rw jukebox!
+--rw library
| +--rw artist* [name]
| | +--rw name string
| | +--rw album* [name]
| | +--rw name string
| | +--rw genre? identityref
| | +--rw year? uint16
| | +--rw admin
| | | +--rw label? string
| | | +--rw catalogue-number? string
| | +--rw song* [name]
| | +--rw name string
| | +--rw location string
| | +--rw format? string
| | +--rw length? uint32
| +--ro artist-count? uint32
| +--ro album-count? uint32
| +--ro song-count? uint32
+--rw playlist* [name]
| +--rw name string
| +--rw description? string
| +--rw song* [index]
| +--rw index uint32
| +--rw id leafref
+--rw player
+--rw gap? decimal64
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
rpcs:
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
+---x play
+--ro input
+--ro playlist string
+--ro song-number uint32
]]></artwork>
</figure>
<section title="example-jukebox YANG Module" anchor="example-module">
<figure>
<artwork><![CDATA[
module example-jukebox {
namespace "http://example.com/ns/example-jukebox";
prefix "jbox";
organization "Example, Inc.";
contact "support at example.com";
description "Example Jukebox Data Model Module";
revision "2015-04-04" {
description "Initial version.";
reference "example.com document 1-4673";
}
identity genre {
description "Base for all genre types";
}
// abbreviated list of genre classifications
identity alternative {
base genre;
description "Alternative music";
}
identity blues {
base genre;
description "Blues music";
}
identity country {
base genre;
description "Country music";
}
identity jazz {
base genre;
description "Jazz music";
}
identity pop {
base genre;
description "Pop music";
}
identity rock {
base genre;
description "Rock music";
}
container jukebox {
presence
"An empty container indicates that the jukebox
service is available";
description
"Represents a jukebox resource, with a library, playlists,
and a play operation.";
container library {
description "Represents the jukebox library resource.";
list artist {
key name;
description
"Represents one artist resource within the
jukebox library resource.";
leaf name {
type string {
length "1 .. max";
}
description "The name of the artist.";
}
list album {
key name;
description
"Represents one album resource within one
artist resource, within the jukebox library.";
leaf name {
type string {
length "1 .. max";
}
description "The name of the album.";
}
leaf genre {
type identityref { base genre; }
description
"The genre identifying the type of music on
the album.";
}
leaf year {
type uint16 {
range "1900 .. max";
}
description "The year the album was released";
}
container admin {
description
"Administrative information for the album.";
leaf label {
type string;
description "The label that released the album.";
}
leaf catalogue-number {
type string;
description "The album's catalogue number.";
}
}
list song {
key name;
description
"Represents one song resource within one
album resource, within the jukebox library.";
leaf name {
type string {
length "1 .. max";
}
description "The name of the song";
}
leaf location {
type string;
mandatory true;
description
"The file location string of the
media file for the song";
}
leaf format {
type string;
description
"An identifier string for the media type
for the file associated with the
'location' leaf for this entry.";
}
leaf length {
type uint32;
units "seconds";
description
"The duration of this song in seconds.";
}
} // end list 'song'
} // end list 'album'
} // end list 'artist'
leaf artist-count {
type uint32;
units "songs";
config false;
description "Number of artists in the library";
}
leaf album-count {
type uint32;
units "albums";
config false;
description "Number of albums in the library";
}
leaf song-count {
type uint32;
units "songs";
config false;
description "Number of songs in the library";
}
} // end library
list playlist {
key name;
description
"Example configuration data resource";
leaf name {
type string;
description
"The name of the playlist.";
}
leaf description {
type string;
description
"A comment describing the playlist.";
}
list song {
key index;
ordered-by user;
description
"Example nested configuration data resource";
leaf index { // not really needed
type uint32;
description
"An arbitrary integer index for this playlist song.";
}
leaf id {
type leafref {
path "/jbox:jukebox/jbox:library/jbox:artist/" +
"jbox:album/jbox:song/jbox:name";
}
mandatory true;
description
"Song identifier. Must identify an instance of
/jukebox/library/artist/album/song/name.";
}
}
}
container player {
description
"Represents the jukebox player resource.";
leaf gap {
type decimal64 {
fraction-digits 1;
range "0.0 .. 2.0";
}
units "tenths of seconds";
description "Time gap between each song";
}
}
}
rpc play {
description "Control function for the jukebox player";
input {
leaf playlist {
type string;
mandatory true;
description "playlist name";
}
leaf song-number {
type uint32;
mandatory true;
description "Song number in playlist to play";
}
}
}
}
]]></artwork>
</figure>
</section>
</section>
<section title="RESTCONF Message Examples" anchor="main-examples">
<t>
The examples within this document use the normative
YANG module defined in <xref target="module"/> and the non-normative
example YANG module defined in <xref target="example-module"/>.
</t>
<t>
This section shows some typical RESTCONF message exchanges.
</t>
<section title="Resource Retrieval Examples">
<section title="Retrieve the Top-level API Resource">
<t>
The client may start by retrieving the top-level
API resource, using the entry point URI "{+restconf}".
</t>
<figure>
<artwork><![CDATA[
GET /restconf HTTP/1.1
Host: example.com
Accept: application/yang.api+json
]]></artwork>
</figure>
<t>
The server might respond as follows:
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-yang-library below to the
date in the published ietf-yang-library YANG module, and remove this
note.]
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.api+json
{
"ietf-restconf:restconf": {
"data" : {},
"operations" : {},
"yang-library-version" : "2016-04-09"
}
}
]]></artwork>
</figure>
<t>
To request that the response content to be encoded in XML,
the "Accept" header can be used, as in this example request:
</t>
<figure>
<artwork><![CDATA[
GET /restconf HTTP/1.1
Host: example.com
Accept: application/yang.api+xml
]]></artwork>
</figure>
<t>
The server will return the same response either way,
which might be as follows :
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-yang-library below to the
date in the published ietf-yang-library YANG module, and remove this
note.]
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.api+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<restconf xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">
<data/>
<operations/>
<yang-library-version>2016-04-09</yang-library-version>
</restconf>
]]></artwork>
</figure>
</section>
<section title="Retrieve The Server Module Information">
<t>
In this example the client is retrieving the modules information
from the server in JSON format:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/ietf-yang-library:modules-state HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond as follows
(some strings wrapped for display purposes):
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-yang-library below to the
date in the published ietf-yang-library YANG module, and remove this
note.]
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Last-Modified: Sun, 22 Apr 2012 01:00:14 GMT
Content-Type: application/yang.data+json
{
"ietf-yang-library:modules-state": {
"module-set-id": "5479120c17a619545ea6aff7aa19838b036ebbd7",
"module": [
{
"name" : "foo",
"revision" : "2012-01-02",
"schema" : "https://example.com/modules/foo/2012-01-02",
"namespace" : "http://example.com/ns/foo",
"feature" : [ "feature1", "feature2" ],
"conformance-type" : "implement"
},
{
"name" : "ietf-yang-library",
"revision" : "2016-04-09",
"schema" : "https://example.com/modules/ietf-yang-
library/2016-04-09",
"namespace" :
"urn:ietf:params:xml:ns:yang:ietf-yang-library",
"conformance-type" : "implement"
},
{
"name" : "foo-types",
"revision" : "2012-01-05",
"schema" :
"https://example.com/modules/foo-types/2012-01-05",
"namespace" : "http://example.com/ns/foo-types",
"conformance-type" : "import"
},
{
"name" : "bar",
"revision" : "2012-11-05",
"schema" : "https://example.com/modules/bar/2012-11-05",
"namespace" : "http://example.com/ns/bar",
"feature" : [ "bar-ext" ],
"conformance-type" : "implement",
"submodule" : [
{
"name" : "bar-submod1",
"revision" : "2012-11-05",
"schema" :
"https://example.com/modules/bar-submod1/2012-11-05"
},
{
"name" : "bar-submod2",
"revision" : "2012-11-05",
"schema" :
"https://example.com/modules/bar-submod2/2012-11-05"
}
]
}
]
}
}
]]></artwork>
</figure>
</section>
<section title="Retrieve The Server Capability Information">
<t>
In this example the client is retrieving the capability information
from the server in XML format, and the server supports all
the RESTCONF query parameters, plus one vendor parameter:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/ietf-restconf-monitoring:restconf-state/
capabilities HTTP/1.1
Host: example.com
Accept: application/yang.data+xml
]]></artwork>
</figure>
<t>
The server might respond as follows.
The extra whitespace in 'capability' elements
for display purposes only.
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:02:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Last-Modified: Sun, 22 Apr 2012 01:00:14 GMT
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<capabilities xmlns="">
<capability>
urn:ietf:params:restconf:capability:depth:1.0
</capability>
<capability>
urn:ietf:params:restconf:capability:fields:1.0
</capability>
<capability>
urn:ietf:params:restconf:capability:filter:1.0
</capability>
<capability>
urn:ietf:params:restconf:capability:start-time:1.0
</capability>
<capability>
urn:ietf:params:restconf:capability:stop-time:1.0
</capability>
<capability>
http://example.com/capabilities/myparam
</capability>
</capabilities>
]]></artwork>
</figure>
</section>
</section>
<section title="Edit Resource Examples">
<section title="Create New Data Resources" anchor="ex-create">
<t>
To create a new "artist" resource within the "library"
resource, the client might send the following request.
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-jukebox:jukebox/library HTTP/1.1
Host: example.com
Content-Type: application/yang.data+json
{
"example-jukebox:artist" : {
"name" : "Foo Fighters"
}
}
]]></artwork>
</figure>
<t>
If the resource is created, the server might respond as follows.
Note that the "Location" header line is wrapped
for display purposes only:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 201 Created
Date: Mon, 23 Apr 2012 17:02:00 GMT
Server: example-server
Location: https://example.com/restconf/data/
example-jukebox:jukebox/library/artist=Foo%20Fighters
Last-Modified: Mon, 23 Apr 2012 17:02:00 GMT
ETag: b3830f23a4c
]]></artwork>
</figure>
<t>
To create a new "album" resource for this artist within the "jukebox"
resource, the client might send the following request.
Note that the request URI header line is wrapped
for display purposes only:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters HTTP/1.1
Host: example.com
Content-Type: application/yang.data+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<album xmlns="http://example.com/ns/example-jukebox">
<name>Wasting Light</name>
<year>2011</year>
</album>
]]></artwork>
</figure>
<t>
If the resource is created, the server might respond
as follows. Note that the "Location" header line is wrapped
for display purposes only:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 201 Created
Date: Mon, 23 Apr 2012 17:03:00 GMT
Server: example-server
Location: https://example.com/restconf/data/
example-jukebox:jukebox/library/artist=Foo%20Fighters/
album=Wasting%20Light
Last-Modified: Mon, 23 Apr 2012 17:03:00 GMT
ETag: b8389233a4c
]]></artwork>
</figure>
</section>
<section title="Detect Resource Entity Tag Change">
<t>
In this example, the server just supports the
mandatory datastore last-changed timestamp.
The client has previously retrieved the "Last‑Modified"
header and has some value cached to provide in
the following request to patch an "album" list entry
with key value "Wasting Light". Only the "genre" field is being
updated.
</t>
<figure>
<artwork><![CDATA[
PATCH /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light/genre
HTTP/1.1
Host: example.com
If-Unmodified-Since: Mon, 23 Apr 2012 17:01:00 GMT
Content-Type: application/yang.data+json
{ "example-jukebox:genre" : "example-jukebox:alternative" }
]]></artwork>
</figure>
<t>
In this example the datastore resource has changed
since the time specified in the "If‑Unmodified‑Since"
header. The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 412 Precondition Failed
Date: Mon, 23 Apr 2012 19:01:00 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 17:45:00 GMT
ETag: b34aed893a4c
]]></artwork>
</figure>
</section>
<section title="Edit a Datastore Resource">
<t>
In this example, the client modifies two different data nodes by
sending a PATCH to the datastore resource:
</t>
<figure>
<artwork><![CDATA[
PATCH /restconf/data HTTP/1.1
Host: example.com
Content-Type: application/yang.datastore+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<data xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">
<jukebox xmlns="http://example.com/ns/example-jukebox">
<library>
<artist>
<name>Foo Fighters</name>
<album>
<name>Wasting Light</name>
<year>2011</year>
</album>
</artist>
<artist>
<name>Nick Cave</name>
<album>
<name>Tender Prey</name>
<year>1988</year>
</album>
</artist>
</library>
</jukebox>
</data>
]]></artwork>
</figure>
</section>
</section>
<section title="Query Parameter Examples" anchor="ex-query">
<section title=""content" Parameter">
<t>
The "content" parameter is used to select the type of
data child resources (configuration and/or not configuration)
that are returned by the server for a GET method request.
</t>
<t>
In this example, a simple YANG list that has configuration
and non-configuration child resources.
</t>
<figure>
<artwork><![CDATA[
container events
list event {
key name;
leaf name { type string; }
leaf description { type string; }
leaf event-count {
type uint32;
config false;
}
}
}
]]></artwork>
</figure>
<t>
Example 1: content=all
</t>
<t>
To retrieve all the child resources, the "content" parameter
is set to "all". The client might send:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-events:events?content=all
HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-events:events" : {
"event" : [
{
"name" : "interface-up",
"description" : "Interface up notification count",
"event-count" : 42
},
{
"name" : "interface-down",
"description" : "Interface down notification count",
"event-count" : 4
}
]
}
}
]]></artwork>
</figure>
<t>
Example 2: content=config
</t>
<t>
To retrieve only the configuration child resources,
the "content" parameter is set to "config" or omitted
since this is the default value. Note that the "ETag"
and "Last‑Modified" headers are only returned if
the content parameter value is "config".
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-events:events?content=config
HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 13:01:20 GMT
ETag: eeeada438af
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-events:events" : {
"event" : [
{
"name" : "interface-up",
"description" : "Interface up notification count"
},
{
"name" : "interface-down",
"description" : "Interface down notification count"
}
]
}
}
]]></artwork>
</figure>
<t>
Example 3: content=nonconfig
</t>
<t>
To retrieve only the non-configuration child resources,
the "content" parameter is set to "nonconfig". Note
that configuration ancestors (if any) and list key leafs
(if any) are also returned. The client might send:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-events:events?content=nonconfig
HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-events:events" : {
"event" : [
{
"name" : "interface-up",
"event-count" : 42
},
{
"name" : "interface-down",
"event-count" : 4
}
]
}
}
]]></artwork>
</figure>
</section>
<section title=""depth" Parameter">
<t>
The "depth" parameter is used to limit the number of levels
of child resources that are returned by the server for
a GET method request.
</t>
<t>
The depth parameter starts counting levels at the
level of the target resource that is specified,
so that a depth level of "1" includes just the target resource
level itself. A depth level of "2" includes the target resource
level and its child nodes.
</t>
<t>
This example shows how different values of the "depth"
parameter would affect the reply content for
retrieval of the top-level "jukebox" data resource.
</t>
<t>
Example 1: depth=unbounded
</t>
<t>
To retrieve all the child resources, the "depth" parameter
is not present or set to the default value "unbounded".
Note that some strings are wrapped for display purposes only.
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox?depth=unbounded
HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-jukebox:jukebox" : {
"library" : {
"artist" : [
{
"name" : "Foo Fighters",
"album" : [
{
"name" : "Wasting Light",
"genre" : "example-jukebox:alternative",
"year" : 2011,
"song" : [
{
"name" : "Wasting Light",
"location" :
"/media/foo/a7/wasting-light.mp3",
"format" : "MP3",
"length" " 286
},
{
"name" : "Rope",
"location" : "/media/foo/a7/rope.mp3",
"format" : "MP3",
"length" " 259
}
]
}
]
}
]
},
"playlist" : [
{
"name" : "Foo-One",
"description" : "example playlist 1",
"song" : [
{
"index" : 1,
"id" : "https://example.com/restconf/data/
example-jukebox:jukebox/library/artist=
Foo%20Fighters/album=Wasting%20Light/
song=Rope"
},
{
"index" : 2,
"id" : "https://example.com/restconf/data/
example-jukebox:jukebox/library/artist=
Foo%20Fighters/album=Wasting%20Light/song=
Bridge%20Burning"
}
]
}
],
"player" : {
"gap" : 0.5
}
}
}
]]></artwork>
</figure>
<t>
Example 2: depth=1
</t>
<t>
To determine if 1 or more resource instances exist for
a given target resource, the value "1" is used.
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox?depth=1 HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-jukebox:jukebox" : {}
}
]]></artwork>
</figure>
<t>
Example 3: depth=3
</t>
<t>
To limit the depth level to the target resource plus 2 child resource layers
the value "3" is used.
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox?depth=3 HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:11:30 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.data+json
{
"example-jukebox:jukebox" : {
"library" : {
"artist" : {}
},
"playlist" : [
{
"name" : "Foo-One",
"description" : "example playlist 1",
"song" : {}
}
],
"player" : {
"gap" : 0.5
}
}
}
]]></artwork>
</figure>
</section>
<section title=""fields" Parameter">
<t>
In this example the client is retrieving the API resource, but
retrieving only the "name" and "revision" nodes
from each module, in JSON format:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data?fields=ietf-yang-library:modules-state/
module(name;revision) HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond as follows.
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-yang-library below to the
date in the published ietf-yang-library YANG module, and remove this
note.]
</t>
<t>
[RFC Editor Note: Adjust the date for ietf-restconf-monitoring below to the
date in the published ietf-restconf-monitoring YANG module, and remove this
note.]
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.data+json
{
"ietf-yang-library:modules-state": {
"module-set-id": "cb4c422111a779e1eed55bffc8d6b46a3a0999e2",
"module": [
{
"name" : "example-jukebox",
"revision" : "2015-06-04"
},
{
"name" : "ietf-inet-types",
"revision" : "2013-07-15"
},
{
"name" : "ietf-restconf-monitoring",
"revision" : "2016-03-16"
},
{
"name" : "ietf-yang-library",
"revision" : "2016-04-09"
},
{
"name" : "ietf-yang-types",
"revision" : "2013-07-15"
}
]
}
}
]]></artwork>
</figure>
</section>
<section title=""insert" Parameter">
<t>
In this example, a new first song entry in the "Foo‑One" playlist
is being created.
</t>
<t>
Request from client:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-jukebox:jukebox/
playlist=Foo-One?insert=first HTTP/1.1
Host: example.com
Content-Type: application/yang.data+json
{
"example-jukebox:song" : {
"index" : 1,
"id" : "/example-jukebox:jukebox/library/
artist=Foo%20Fighters/album=Wasting%20Light/song=Rope"
}
}
]]></artwork>
</figure>
<t>
Response from server:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 201 Created
Date: Mon, 23 Apr 2012 13:01:20 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 13:01:20 GMT
Location: https://example.com/restconf/data/
example-jukebox:jukebox/playlist=Foo-One/song=1
ETag: eeeada438af
]]></artwork>
</figure>
</section>
<section title=""point" Parameter">
<t>
In this example, the client is inserting a new "song"
resource within an "album" resource after another song.
The request URI is split for display purposes only.
</t>
<t>
Request from client:
</t>
<figure>
<artwork><![CDATA[
POST /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album=Wasting%20Light?
insert=after&point=%2Fexample-jukebox%3Ajukebox%2F
library%2Fartist%3DFoo%20Fighters%2Falbum%3D
Wasting%20Light%2Fsong%3DBridge%20Burning HTTP/1.1
Host: example.com
Content-Type: application/yang.data+json
{
"example-jukebox:song" : {
"name" : "Rope",
"location" : "/media/foo/a7/rope.mp3",
"format" : "MP3",
"length" : 259
}
}
]]></artwork>
</figure>
<t>
Response from server:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 204 No Content
Date: Mon, 23 Apr 2012 13:01:20 GMT
Server: example-server
Last-Modified: Mon, 23 Apr 2012 13:01:20 GMT
ETag: abcada438af
]]></artwork>
</figure>
</section>
<section title=""filter" Parameter" anchor="ex-filters">
<t>
The following URIs show some examples of notification filter
specifications (lines wrapped for display purposes only):
</t>
<figure>
<artwork><![CDATA[
// filter = /event/event-class='fault'
GET /streams/NETCONF?filter=%2Fevent%2Fevent-class%3D'fault'
// filter = /event/severity<=4
GET /streams/NETCONF?filter=%2Fevent%2Fseverity%3C%3D4
// filter = /linkUp|/linkDown
GET /streams/SNMP?filter=%2FlinkUp%7C%2FlinkDown
// filter = /*/reporting-entity/card!='Ethernet0'
GET /streams/NETCONF?
filter=%2F*%2Freporting-entity%2Fcard%21%3D'Ethernet0'
// filter = /*/email-addr[contains(.,'company.com')]
GET /streams/critical-syslog?
filter=%2F*%2Femail-addr[contains(.%2C'company.com')]
// Note: the module name is used as prefix.
// filter = (/example-mod:event1/name='joe' and
// /example-mod:event1/status='online')
GET /streams/NETCONF?
filter=(%2Fexample-mod%3Aevent1%2Fname%3D'joe'%20and
%20%2Fexample-mod%3Aevent1%2Fstatus%3D'online')
// To get notifications from just two modules (e.g., m1 + m2)
// filter=(/m1:* or /m2:*)
GET /streams/NETCONF?filter=(%2Fm1%3A*%20or%20%2Fm2%3A*)
]]></artwork>
</figure>
</section>
<section title=""start-time" Parameter">
<figure>
<artwork><![CDATA[
// start-time = 2014-10-25T10:02:00Z
GET /streams/NETCONF?start-time=2014-10-25T10%3A02%3A00Z
]]></artwork>
</figure>
</section>
<section title=""stop-time" Parameter">
<figure>
<artwork><![CDATA[
// stop-time = 2014-10-25T12:31:00Z
GET /mystreams/NETCONF?stop-time=2014-10-25T12%3A31%3A00Z
]]></artwork>
</figure>
</section>
<section title=""with-defaults" Parameter" anchor="with-defaults-example">
<t>
The following YANG module is assumed for this example.
</t>
<figure>
<artwork><![CDATA[
module example-interface {
prefix "exif";
namespace "urn:example.com:params:xml:ns:yang:example-interface";
container interfaces {
list interface {
key name;
leaf name { type string; }
leaf mtu { type uint32; }
leaf status {
config false;
type enumeration {
enum up;
enum down;
enum testing;
}
}
}
}
}
]]></artwork>
</figure>
<t>
Assume the same data model as defined in Appendix A.1 of <xref target="RFC6243"/>.
Assume the same data set as defined in Appendix A.2 of <xref target="RFC6243"/>.
If the server defaults-uri basic-mode is "trim", the the
following request for interface "eth1" might be as follows:
</t>
<t>
Without query parameter:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example:interfaces/interface=eth1 HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond as follows.
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.data+json
{
"example:interface": [
{
"name" : "eth1",
"status" : "up"
}
]
}
]]></artwork>
</figure>
<t>
Note that the "mtu" leaf is missing because it is set to
the default "1500", and the server defaults handling
basic-mode is "trim".
</t>
<t>
With query parameter:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example:interfaces/interface=eth1
?with-defaults=report-all HTTP/1.1
Host: example.com
Accept: application/yang.data+json
]]></artwork>
</figure>
<t>
The server might respond as follows.
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Content-Type: application/yang.data+json
{
"example:interface": [
{
"name" : "eth1",
"mtu" : 1500,
"status" : "up"
}
]
}
]]></artwork>
</figure>
<t>
Note that the server returns the "mtu" leaf because the "report‑all"
mode was requested with the "with‑defaults" query parameter.
</t>
</section>
</section>
</section>
</back></rfc>
| PAFTECH AB 2003-2026 | 2026-04-22 22:09:19 |