object_and_properties¶
Overview¶
API to retrieve the available object names and properties which can be retrieved using the monitoring statistics api
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitoring/
Schemes : HTTP
Tags¶
- object_and_properties : Operations related to object_and_properties
Paths¶
Get operation for object_and_properties¶
GET /object_and_properties
Description¶
Use this operation to get a list of available object names and properties
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | object_and_properties_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¶
- object_and_properties
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
available_stats¶
The available properties for each type of object
Type : < available_stats > array
| Name | Description | Schema |
|---|---|---|
| lan_to_wan_paths optional read-only |
The lan to wan path properties available | < string > array |
| virtual_path optional read-only |
The virtual path properties available | < string > array |
| wan_link optional read-only |
The wan link properties available | < string > array |
| wan_to_lan_paths optional read-only |
The wan to lan path properties available | < string > array |
object_and_properties_delete_success_schema¶
| Name | Schema |
|---|---|
| object_and_properties optional |
object_and_properties |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
object_and_properties_post_success_schema¶
| Name | Schema |
|---|---|
| object_and_properties optional |
object_and_properties |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
object_and_properties_put_success_schema¶
| Name | Schema |
|---|---|
| object_and_properties optional |
object_and_properties |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
object_and_properties_response_schema¶
Type : < object_and_properties_response_schema > array
object_and_properties_response_schema
| Name | Schema |
|---|---|
| available_stats optional |
available_stats |
| sites optional |
sites |
sites¶
The site and related object names
Type : < sites > array
| Name | Description | Schema |
|---|---|---|
| name optional read-only |
The site name | string |
| virtual_paths optional read-only |
The virtual path and related path names associated with this site | < virtual_paths > array |
| wan_links optional read-only |
The wan link names available for that site | < string > array |
| Name | Description | Schema |
|---|---|---|
| lan_to_wan_paths optional read-only |
The LAN to WAN Path names available for this virtual path | string |
| name optional read-only |
The virtual path name | string |
| wan_to_lan_paths optional read-only |
The WAN to LAN Path names available for this virtual path | string |