Skip to content

collector_configuration

Overview

This resource can be used for getting collector configuration

Version information

Version : v2

URI scheme

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

Tags

  • collector_configuration : Operations related to collector_configuration

Paths

Get operation for collector_configuration

GET /collector_configuration

Description

Use this operation to get the collector configuration settings

Responses

HTTP Code Description Schema
200 API Successfully executed collector_configuration_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

  • collector_configuration

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

collector_configuration_delete_success_schema

Name Schema
collector_configuration
optional
collector_configuration

collector_configuration

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

collector_configuration_post_success_schema

Name Schema
collector_configuration
optional
collector_configuration

collector_configuration

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

collector_configuration_put_success_schema

Name Schema
collector_configuration
optional
collector_configuration

collector_configuration

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

collector_configuration_response_schema

Type : < collector_configuration_response_schema > array

collector_configuration_response_schema

Name Schema
collector_ip
optional
collector_ip
discovery_status
optional
discovery_status
rcn_ip
optional
rcn_ip
region_name
optional
region_name

collector_ip

The IP Address of the collector

Type : string

discovery_status

The discovery status of region appliances

Type : string

rcn_ip

The IP Address of the corresponding RCN

Type : string

region_name

The region whose appliances are polled by the collector

Type : string