Cisco NSO icon

Cisco NSO

Interact with Cisco Network Services Orchestrator (NSO) via RESTCONF API

Service → Get

AI-generated

Summary

Retrieve details of a specific service instance or a list of service instances from Cisco NSO.

Inputs

  • servicePath (required) — Path to the service in YANG format.
  • serviceInstance (required) — Name/key of the service instance.
  • additionalOptions — Optional parameters to refine the request, including commit queue mode, subtree depth, dry run option, networking behavior, and response format.

Output shape

a list of service instance details or an individual record based on the request

Returns JSON or XML format based on the 'Response Format' option. If no service instance is specified, all service instances are retrieved.

Examples

Example 1: Get details of a specific service instance

[servicePath: "/my_service:service", serviceInstance: "instance1"]

Example 2: List all service instances

[servicePath: "/my_service:service", serviceInstance: ""]

Discussion