Skip to content

virtual_paths

Overview

This resource provides details of all the virtual paths in the system

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP

Tags

  • virtual_paths : Operations related to virtual_paths

Paths

Get operation for virtual_paths

GET /virtual_paths

Description

Use this operation to get Virtual Paths status

Responses

HTTP Code Description Schema
200 API Successfully executed virtual_paths_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • virtual_paths

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

name

Name of the Virtual Path

Type : string

status

Virtual Path Status

Type : enum (up, down)

uptime

Uptime of the Virtual Path

Type : string

virtual_paths_delete_success_schema

Name Schema
virtual_paths
optional
virtual_paths

virtual_paths

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

virtual_paths_post_success_schema

Name Schema
virtual_paths
optional
virtual_paths

virtual_paths

Name Description Schema
message
optional
Example : "resource added succesfully" string

virtual_paths_put_success_schema

Name Schema
virtual_paths
optional
virtual_paths

virtual_paths

Name Description Schema
message
optional
Example : "resource modified succesfully" string

virtual_paths_response_schema

Type : < virtual_paths_response_schema > array

virtual_paths_response_schema

Name Schema
name
optional
name
status
optional
status
uptime
optional
uptime