REST API Interface
REST API documentation of the gNMIc Operator with available endpoints and required request formats.
Documentation for API Endpoints
All URIs are relative to http://localhost:8082
| Class | Method | HTTP request | Description |
|---|---|---|---|
| defaultapi | getClusterPlan | GET /clusters/:namespace/:name/plan | Get cluster plan. |
| defaultapi | refreshTargetSource | POST /api/v1/namespaces/:namespace/targetsources/:name/refresh | Request an immediate discovery run for a TargetSource. |
Documentation for Models
Documentation for Authorization
For a detailed explanation on how to configure the required secrets within the gNMIc Operator, refer to TargetSource > Webhook.
bearerAuth
- Type: HTTP Bearer Token authentication
signature
- Type: API key
- API key parameter name: X-Hook-Signature
- Location: HTTP header