Model
Documentation for OpenAPI models and their schema-defined properties.
REST API interface
This document describes the REST API exposed by the gNMIc Operator, including the available endpoints, request formats, and usage examples.
Documentation for API Endpoints
All URIs are relative to http://localhost:8082
| Class | Method | HTTP request | Description |
|---|---|---|---|
| defaultapi | 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. |
| defaultapi | getClusterPlan | GET /clusters/:namespace/:name/plan | Get cluster plan. |
Documentation for Models
Documentation for Authorization
For a detailed explanation on how to configure the required secrets within the gNMIc Operator, refer to TargetSource > Push mode.
bearerAuth
- Type: HTTP Bearer Token authentication
signature
- Type: API key
- API key parameter name: X-Hook-Signature
- Location: HTTP header