OpenAPI Specification
openapi: 3.2.0
info:
description: This document contains details of the Crosswork Network Controller nso-connector APIs
version: '2.0'
title: Crosswork Network Controller CAT NSO Connector API Controller API
contact:
name: Crosswork Team, Cisco
email: support@cisco.com
license:
name: Cisco Software License Agreement
url: http://www.cisco.com/public/sw-license-agreement.html
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
x-evidence:
- type: source
url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/CNC/2.0APIs/nso_connector_service.swagger.json
- type: raw
url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/CNC/2.0APIs/nso_connector_service.swagger.json
servers:
- url: https://localhost:8080
tags:
- name: api-controller
description: API Controller
paths:
/api/fullResync:
post:
tags:
- api-controller
summary: Performs a full resync for all service types.
description: This is heavy operation, use with caution.
operationId: fullResyncUsingPOST
parameters:
- name: force
in: query
description: true or false. Default true.
required: false
x-example: 'false'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/serviceResync:
post:
tags:
- api-controller
summary: Resyncs service by service type and name.
description: Resyncs the service and service-plan of this service.
operationId: serviceResyncUsingPOST
parameters:
- name: serviceName
in: query
description: The name of the service.
required: true
schema:
type: string
- name: typePath
in: query
description: This parameter is lenient. We recommend that you use the full path as shown in the following example.
required: true
x-example: ietf-l2vpn-ntw:l2vpn-ntw/vpn-services/vpn-service
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/serviceStatus:
get:
tags:
- api-controller
summary: Retrieves the service status. Use for development and debugging purposes only.
description: Retrieves the status of the service, which is active/standby (leader/follower).
operationId: serviceStatusUsingGET
parameters:
- name: extended
in: query
description: 'Use for development purposes only. The value is true or false. The default value is false. When true, it adds extended status, including NSO provider related status. '
required: false
x-example: 'true'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/typeResync:
post:
tags:
- api-controller
summary: Resyncs by service type.
description: Resyncs the service, service-plan, and resources of this service type.
operationId: typeResyncUsingPOST
parameters:
- name: force
in: query
description: force
required: false
schema:
type: string
- name: typePath
in: query
description: 'This parameter is lenient. We recommend that you use the full path as shown in the following example:'
required: true
x-example: ietf-l2vpn-ntw:l2vpn-ntw/vpn-services/vpn-service
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found