REST API interface on gNMIc Operator

Model

Mon, 01 Jan 0001 00:00:00 +0000

Network device to be monitored. Properties not marked as optional must be in JSON body.

Name	Type	Description	Notes
name	String	Name of device to be monitored.	[default to null]
address	String	IPv4/IPv6 address or hostname.	[default to null]
port	Integer	gNMIc port.	[optional] [default to null]
targetProfile	String	TargetProfile applied to apply to this router.	[optional] [default to null]
labels	List	Input of labels as key:value pair.	[optional] [default to null]
operation	String	Either `created`, `updated` or `deleted`. `created` and `updated` are identical and both apply the target.	[default to null]

Mon, 01 Jan 0001 00:00:00 +0000

All URIs are relative to http://localhost:8082

Method	HTTP request	Description
applyTargets	POST /api/v1/:namespace/target-source/:name/applyTargets	Interface for real-time target updates, usually using a webhook. Targets are applied in the gNMIc Operator.
getClusterPlan	GET /clusters/:namespace/:name/plan	Get cluster plan.

List applyTargets(Target)

Interface for real-time target updates, usually using a webhook. Targets are applied in the gNMIc Operator.

Name	Type	Description	Notes
Target	List	Target must be passed as a list, multiple targets possible.