Cisco Crosswork

Cisco Crosswork Data API

data resources

GitHub OpenAPI
Business capability
Network Inventory Management BC-2600.40

Operations 138

GET /data This module defines a model for Layer 3 Unicast topologies. Copyright (c) 2018 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and #
POST /data This module defines a model for Layer 3 Unicast topologies. Copyright (c) 2018 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and #
GET /data/ietf-network-state:networks Serves as a top-level container for a list of networks. #
GET /data/ietf-network-state:networks/network Describes a network. A network typically contains an inventory of nodes, topological information (augmented through the network-topology data model), and layering information. #
GET /data/ietf-network-state:networks/network={network-network-id} Describes a network. A network typically contains an inventory of nodes, topological information (augmented through the network-topology data model), and layering information. #
GET /data/ietf-network-state:networks/network={network-network-id}/network-types Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container. #
GET /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology The presence of the container node indicates L3 Unicast topology #
GET /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/cisco-crosswork-isis-topology:isis Presence of this node identifies the ISIS topology type. #
GET /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/cisco-crosswork-ospf-topology:ospf Presence of this node identifies the OSPF topology type. #
GET /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/ietf-sr-topology-state:sr-mpls Its presence identifies the SR topology type. #
GET /data/ietf-network-state:networks/network={network-network-id}/network-id Identifies a network. #
GET /data/ietf-network-state:networks/network={network-network-id}/supporting-network An underlay network, used to represent layered network topologies. #
GET /data/ietf-network-state:networks/network={network-network-id}/supporting-network={supporting-network-network-ref} An underlay network, used to represent layered network topologies. #
GET /data/ietf-network-state:networks/network={network-network-id}/supporting-network={supporting-network-network-ref}/network-ref References the underlay network. #
GET /data/ietf-network-state:networks/network={network-network-id}/node The inventory of nodes of this network. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id} The inventory of nodes of this network. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/node-id Uniquely identifies a node within the containing network. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node Represents another node that is in an underlay network and that supports this node. Used to represent layering structure. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node={supporting-node-network-ref},{supporting-node-node-ref} Represents another node that is in an underlay network and that supports this node. Used to represent layering structure. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node={supporting-node-network-ref},{supporting-node-node-ref}/network-ref References the underlay network of which the underlay node is a part. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node={supporting-node-network-ref},{supporting-node-node-ref}/node-ref References the underlay node itself. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point A termination point can terminate a link. Depending on the type of topology, a termination point could, for example, refer to a port or an interface. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id} A termination point can terminate a link. Depending on the type of topology, a termination point could, for example, refer to a port or an interface. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:tp-id Termination point identifier. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:supporting-termination-point This list identifies any termination points on which a given termination point depends or onto which it maps. Those termination points will themselves be contained in a supporting #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:supporting-termination-point={ietf-network-topology-state_supporting-termination-point-network-ref},{ietf-network-topology-state_supporting-termination-point-node-ref},{ietf-network-topology-state_supporting-termination-point-tp-ref} This list identifies any termination points on which a given termination point depends or onto which it maps. Those termination points will themselves be contained in a supporting #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:supporting-termination-point={ietf-network-topology-state_supporting-termination-point-network-ref},{ietf-network-topology-state_supporting-termination-point-node-ref},{ietf-network-topology-state_supporting-termination-point-tp-ref}/ietf-network-topology-state:network-ref This leaf identifies in which topology the supporting termination point is present. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:supporting-termination-point={ietf-network-topology-state_supporting-termination-point-network-ref},{ietf-network-topology-state_supporting-termination-point-node-ref},{ietf-network-topology-state_supporting-termination-point-tp-ref}/ietf-network-topology-state:node-ref This leaf identifies in which node the supporting termination point is present. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-network-topology-state:supporting-termination-point={ietf-network-topology-state_supporting-termination-point-network-ref},{ietf-network-topology-state_supporting-termination-point-node-ref},{ietf-network-topology-state_supporting-termination-point-tp-ref}/ietf-network-topology-state:tp-ref Reference to the underlay node (the underlay node must be in a different topology). #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-l3-unicast-topology-state:l3-termination-point-attributes Contains termination point attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-l3-unicast-topology-state:l3-termination-point-attributes/ietf-l3-unicast-topology-state:ip-address IPv4 or IPv6 address. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-l3-unicast-topology-state:l3-termination-point-attributes/ietf-l3-unicast-topology-state:ip-address={ietf-l3-unicast-topology-state_ip-address-id} IPv4 or IPv6 address. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-l3-unicast-topology-state:l3-termination-point-attributes/ietf-l3-unicast-topology-state:unnumbered-id Unnumbered interface identifier. The identifier will correspond to the ifIndex value of the interface, i.e., the ifIndex value of the ifEntry that represents the interface in imple #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-network-topology-state:termination-point={ietf-network-topology-state_termination-point-tp-id}/ietf-l3-unicast-topology-state:l3-termination-point-attributes/ietf-l3-unicast-topology-state:interface-name Name of the interface. The name can (but does not have to) correspond to an interface reference of a containing node's interface, i.e., the path name of a corresponding interface d #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes Contains node attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:name Node name #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:flag Node flags #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:flag={ietf-l3-unicast-topology-state_flag-id} Node flags #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:router-id Router-id for the node #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:router-id={ietf-l3-unicast-topology-state_router-id-id} Router-id for the node #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix A list of prefixes along with their attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix} A list of prefixes along with their attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-l3-unicast-topology-state:prefix IP prefix value #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-l3-unicast-topology-state:metric Prefix metric #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-l3-unicast-topology-state:flag Prefix flags #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-l3-unicast-topology-state:flag={ietf-l3-unicast-topology-state_flag-id} Prefix flags #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr Containing SR attributes for a prefix. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:value-type This leaf defines how value must be interpreted. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:start-sid Value associated with prefix. The value must be interpreted in the context of value-type. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:range Indicates how many SIDs can be allocated. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:algorithm Prefix-sid algorithm. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:last-hop-behavior Configure last hop behavior. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:is-local 'true' if the SID is local. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:is-node 'true' if the Prefix-SID refers to the router identified by the prefix. Typically, the leaf 'is-node' (N-Flag) is set on Prefix-SIDs attached to a router loopback address. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-l3-unicast-topology-state:prefix={ietf-l3-unicast-topology-state_prefix-prefix}/ietf-sr-topology-state:sr/ietf-sr-topology-state:is-readvertisment 'true' if the prefix to which this Prefix-SID is attached, has been propagated by the router from another topology by redistribution. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-isis-topology:isis-node-attributes ISIS attributes for a specific node #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-isis-topology:isis-node-attributes/cisco-crosswork-isis-topology:system-id ISIS System ID, a 6 octet numerical value #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-isis-topology:isis-node-attributes/cisco-crosswork-isis-topology:area List of Area addresses. *** Should we return only a single Area address corresponding to the current network?? #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-isis-topology:isis-node-attributes/cisco-crosswork-isis-topology:area={cisco-crosswork-isis-topology_area-id} List of Area addresses. *** Should we return only a single Area address corresponding to the current network?? #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-isis-topology:isis-node-attributes/cisco-crosswork-isis-topology:level Level 1, Level 2 or Level 1 & 2 #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-ospf-topology:ospf-node-attributes Contains node's OSPF attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-ospf-topology:ospf-node-attributes/cisco-crosswork-ospf-topology:ospf-router-id OSPF router ID, which is an IPv4 address. *** Note, only one router-ID is reported, corresponwing to the IGP domain of the current network #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-ospf-topology:ospf-node-attributes/cisco-crosswork-ospf-topology:area-id List of OSPF area IDs, each represented as an IPv4 address value *** Should we report all Areas or just the one corresponwing to the network?? #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/cisco-crosswork-ospf-topology:ospf-node-attributes/cisco-crosswork-ospf-topology:area-id={cisco-crosswork-ospf-topology_area-id-id} List of OSPF area IDs, each represented as an IPv4 address value *** Should we report all Areas or just the one corresponwing to the network?? #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr Containing SR attributes. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb List of global blocks to be advertised. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound} List of global blocks to be advertised. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound}/ietf-sr-topology-state:lower-bound Lower value in the label range. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound}/ietf-sr-topology-state:upper-bound Upper value in the label range. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srlb List of SRLBs. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srlb={ietf-sr-topology-state_srlb-lower-bound},{ietf-sr-topology-state_srlb-upper-bound} List of SRLBs. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srlb={ietf-sr-topology-state_srlb-lower-bound},{ietf-sr-topology-state_srlb-upper-bound}/ietf-sr-topology-state:lower-bound Lower value in the label range. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srlb={ietf-sr-topology-state_srlb-lower-bound},{ietf-sr-topology-state_srlb-upper-bound}/ietf-sr-topology-state:upper-bound Upper value in the label range. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:node-capabilities Shows the SR capability of the node. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:node-capabilities/ietf-sr-topology-state:transport-planes List of supported transport planes. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:node-capabilities/ietf-sr-topology-state:transport-planes={ietf-sr-topology-state_transport-planes-transport-plane} List of supported transport planes. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:node-capabilities/ietf-sr-topology-state:transport-planes={ietf-sr-topology-state_transport-planes-transport-plane}/ietf-sr-topology-state:transport-plane Transport plane supported #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:node-capabilities/ietf-sr-topology-state:entropy-readable-label-depth Maximum label stack depth that a router can read. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:msd Node MSD is the lowest MSD supported by the node. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:information-source Indicates the type of the information source. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:information-source-instance The name indicating the instance of the information source. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:information-source-state The container contains state attributes related to the information source. #
GET /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/ietf-l3-unicast-topology-state:l3-node-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:information-source-state/ietf-sr-topology-state:credibility-preference The preference value to calculate the traffic engineering database credibility value used for tie-break selection between different information-source values. Higher value is more #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes Contains topology attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-l3-unicast-topology-state:name Name of the topology #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-l3-unicast-topology-state:flag Topology flags #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-l3-unicast-topology-state:flag={ietf-l3-unicast-topology-state_flag-id} Topology flags #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/cisco-crosswork-isis-topology:isis-topology-attributes Contains ISIS topology attributes. *** Contains a single Area address, which means each nw:ietf-network must contain a single ISIS Area. is this what we want?? *** How do we identi #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/cisco-crosswork-isis-topology:isis-topology-attributes/cisco-crosswork-isis-topology:area ISIS Area address. Numerical value of 1 to 13 octets #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/cisco-crosswork-ospf-topology:ospf-topology-attributes OSPF topology attributes #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/cisco-crosswork-ospf-topology:ospf-topology-attributes/cisco-crosswork-ospf-topology:area-id OSPF area ID, represented as an IPv4 address value. *** Contains a single Area ID, which means each ietf-network must contain a single OSPF Area. is this what we want?? *** How do #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-sr-topology-state:sr Containing SR attributes. #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb List of global blocks to be advertised. #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound} List of global blocks to be advertised. #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound}/ietf-sr-topology-state:lower-bound Lower value in the label range. #
GET /data/ietf-network-state:networks/network={network-network-id}/ietf-l3-unicast-topology-state:l3-topology-attributes/ietf-sr-topology-state:sr/ietf-sr-topology-state:srgb={ietf-sr-topology-state_srgb-lower-bound},{ietf-sr-topology-state_srgb-upper-bound}/ietf-sr-topology-state:upper-bound Upper value in the label range. #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cisco-crosswork/refs/heads/main/openapi/cisco-crosswork-data-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cisco-crosswork-data-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cisco-crosswork-data-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cisco Crosswork Data API
  version: '2018-02-26'
  description: 'Operations tagged data across 3 of this provider''s published API definitions: cisco-crosswork-coe-l3-openapi.json, cisco-crosswork-coe-l3-state-openapi.json, cisco-crosswork-coe-network-state-openapi.json. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of cisco-crosswork-coe-network-state-openapi.json, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-crosswork-coe-network-state-openapi.json
    operation_coverage: 138/138
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/COE/1.1APIs/network_state.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/COE/1.1APIs/network_state.swagger.json
servers:
- url: /crosswork/nbi/optima/v1/restconf
tags:
- name: data
  description: data resources
paths:
  /data:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 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

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      description: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 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

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      operationId: data_get
      responses:
        '200':
          description: 'This module defines a model for Layer 3 Unicast

            topologies.

            Copyright (c) 2018 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

            (https://trustee.ietf.org/license-info).

            This version of this YANG module is part of

            RFC 8346; see the RFC itself for full legal notices.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
    post:
      tags:
      - data
      summary: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 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

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      description: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 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

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      operationId: data_post
      parameters:
      - $ref: '#/components/parameters/data-post'
      responses:
        '201':
          description: 'This module defines a model for Layer 3 Unicast

            topologies.

            Copyright (c) 2018 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

            (https://trustee.ietf.org/license-info).

            This version of this YANG module is part of

            RFC 8346; see the RFC itself for full legal notices.'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: Serves as a top-level container for a list of networks.
      description: Serves as a top-level container for a list of networks.
      operationId: data_ietf_network_state_networks_get
      parameters:
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: Serves as a top-level container for a list of networks.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Describes a network.

        A network typically contains an inventory of nodes,

        topological information (augmented through the

        network-topology data model), and layering information.'
      description: 'Describes a network.

        A network typically contains an inventory of nodes,

        topological information (augmented through the

        network-topology data model), and layering information.'
      operationId: data_ietf_network_state_networks_network_get
      parameters:
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'Describes a network.

            A network typically contains an inventory of nodes,

            topological information (augmented through the

            network-topology data model), and layering information.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Describes a network.

        A network typically contains an inventory of nodes,

        topological information (augmented through the

        network-topology data model), and layering information.'
      description: 'Describes a network.

        A network typically contains an inventory of nodes,

        topological information (augmented through the

        network-topology data model), and layering information.'
      operationId: data_ietf_network_state_networks_network_network_network_id_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'Describes a network.

            A network typically contains an inventory of nodes,

            topological information (augmented through the

            network-topology data model), and layering information.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/network-types:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Serves as an augmentation target.

        The network type is indicated through corresponding

        presence containers augmented into this container.'
      description: 'Serves as an augmentation target.

        The network type is indicated through corresponding

        presence containers augmented into this container.'
      operationId: data_ietf_network_state_networks_network_network_network_id_network_types_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'Serves as an augmentation target.

            The network type is indicated through corresponding

            presence containers augmented into this container.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-types'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'The presence of the container node indicates L3 Unicast

        topology'
      description: 'The presence of the container node indicates L3 Unicast

        topology'
      operationId: data_ietf_network_state_networks_network_network_network_id_network_types_ietf_l3_unicast_topology_state_l3_unicast_topology_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'The presence of the container node indicates L3 Unicast

            topology'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-types_ietf-l3-unicast-topology-state_l3-unicast-topology'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/cisco-crosswork-isis-topology:isis
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: Presence of this node identifies the ISIS topology type.
      description: Presence of this node identifies the ISIS topology type.
      operationId: data_ietf_network_state_networks_network_network_network_id_network_types_ietf_l3_unicast_topology_state_l3_unicast_topology_cisco_crosswork_isis_topology_isis_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: Presence of this node identifies the ISIS topology type.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-types_ietf-l3-unicast-topology-state_l3-unicast-topology_cisco-crosswork-isis-topology_isis'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/cisco-crosswork-ospf-topology:ospf
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: Presence of this node identifies the OSPF topology type.
      description: Presence of this node identifies the OSPF topology type.
      operationId: data_ietf_network_state_networks_network_network_network_id_network_types_ietf_l3_unicast_topology_state_l3_unicast_topology_cisco_crosswork_ospf_topology_ospf_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: Presence of this node identifies the OSPF topology type.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-types_ietf-l3-unicast-topology-state_l3-unicast-topology_cisco-crosswork-ospf-topology_ospf'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/network-types/ietf-l3-unicast-topology-state:l3-unicast-topology/ietf-sr-topology-state:sr-mpls
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: Its presence identifies the SR topology type.
      description: Its presence identifies the SR topology type.
      operationId: data_ietf_network_state_networks_network_network_network_id_network_types_ietf_l3_unicast_topology_state_l3_unicast_topology_ietf_sr_topology_state_sr_mpls_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: Its presence identifies the SR topology type.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-types_ietf-l3-unicast-topology-state_l3-unicast-topology_ietf-sr-topology-state_sr-mpls'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/network-id:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: Identifies a network.
      description: Identifies a network.
      operationId: data_ietf_network_state_networks_network_network_network_id_network_id_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: Identifies a network.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_network-id'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/supporting-network:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'An underlay network, used to represent layered network

        topologies.'
      description: 'An underlay network, used to represent layered network

        topologies.'
      operationId: data_ietf_network_state_networks_network_network_network_id_supporting_network_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'An underlay network, used to represent layered network

            topologies.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_supporting-network'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/supporting-network={supporting-network-network-ref}:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'An underlay network, used to represent layered network

        topologies.'
      description: 'An underlay network, used to represent layered network

        topologies.'
      operationId: data_ietf_network_state_networks_network_network_network_id_supporting_network_supporting_network_network_ref_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/supporting-network-network-ref'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'An underlay network, used to represent layered network

            topologies.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_supporting-network_supporting-network-network-ref'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/supporting-network={supporting-network-network-ref}/network-ref
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: References the underlay network.
      description: References the underlay network.
      operationId: data_ietf_network_state_networks_network_network_network_id_supporting_network_supporting_network_network_ref_network_ref_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/supporting-network-network-ref'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: References the underlay network.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_supporting-network_supporting-network-network-ref_network-ref'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/node:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: The inventory of nodes of this network.
      description: The inventory of nodes of this network.
      operationId: data_ietf_network_state_networks_network_network_network_id_node_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: The inventory of nodes of this network.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_node'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: The inventory of nodes of this network.
      description: The inventory of nodes of this network.
      operationId: data_ietf_network_state_networks_network_network_network_id_node_node_node_id_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/node-node-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: The inventory of nodes of this network.
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_node_node-node-id'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/node-id:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Uniquely identifies a node within the containing

        network.'
      description: 'Uniquely identifies a node within the containing

        network.'
      operationId: data_ietf_network_state_networks_network_network_network_id_node_node_node_id_node_id_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/node-node-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'Uniquely identifies a node within the containing

            network.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_node_node-node-id_node-id'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node:
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Represents another node that is in an underlay network

        and that supports this node.  Used to represent layering

        structure.'
      description: 'Represents another node that is in an underlay network

        and that supports this node.  Used to represent layering

        structure.'
      operationId: data_ietf_network_state_networks_network_network_network_id_node_node_node_id_supporting_node_get
      parameters:
      - $ref: '#/components/parameters/network-network-id'
      - $ref: '#/components/parameters/node-node-id'
      - $ref: '#/components/parameters/content'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/with-defaults'
      responses:
        '200':
          description: 'Represents another node that is in an underlay network

            and that supports this node.  Used to represent layering

            structure.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_ietf-network-state_networks_network_network-network-id_node_node-node-id_supporting-node'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
  ? /data/ietf-network-state:networks/network={network-network-id}/node={node-node-id}/supporting-node={supporting-node-network-ref},{supporting-node-node-ref}
  : servers:
    - url: /crosswork/nbi/optima/v1/restconf
    get:
      tags:
      - data
      summary: 'Represents ano

# --- truncated at 32 KB (627 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-crosswork/refs/heads/main/openapi/cisco-crosswork-data-api-openapi.yml