netgate-vpp-prometheus API (25.02)

prometheus-exporter

returns netgate.vpp.prometheus.PrometheusExporter

configuration of the prometheus exporter

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-vpp-prometheus:prometheus-exporter": {"netgate-vpp-prometheus:dataplane-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
},
"netgate-vpp-prometheus:host-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}
}

creates netgate.vpp.prometheus.PrometheusExporter

configuration of the prometheus exporter

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.PrometheusExporter to be added to list

	object (netgate.vpp.prometheus.prometheusexporter.DataplaneSpace)
	object (netgate.vpp.prometheus.prometheusexporter.HostSpace)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:dataplane-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
},
"netgate-vpp-prometheus:host-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}

creates or updates netgate.vpp.prometheus.PrometheusExporter

configuration of the prometheus exporter

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.PrometheusExporter to be added or updated

object (netgate.vpp.prometheus.PrometheusExporter)

configuration of the prometheus exporter

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:prometheus-exporter": {"netgate-vpp-prometheus:dataplane-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
},
"netgate-vpp-prometheus:host-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}
}

removes netgate.vpp.prometheus.PrometheusExporter

configuration of the prometheus exporter

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.vpp.prometheus.prometheusexporter.DataplaneSpace

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/dataplane-space"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-vpp-prometheus:dataplane-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}

creates netgate.vpp.prometheus.prometheusexporter.DataplaneSpace

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.DataplaneSpace to be added to list

object (netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters)

list of data items to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

creates or updates netgate.vpp.prometheus.prometheusexporter.DataplaneSpace

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.DataplaneSpace to be added or updated

object (netgate.vpp.prometheus.prometheusexporter.DataplaneSpace)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:dataplane-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}

removes netgate.vpp.prometheus.prometheusexporter.DataplaneSpace

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/dataplane-space"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters

list of data items to export

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/dataplane-space/filters"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

creates netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters

list of data items to export

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters to be added to list

netgate-vpp-prometheus:filter

Array of strings

regular expression for data to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filter": ["string"
]
}

creates or updates netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters

list of data items to export

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters to be added or updated

object (netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters)

list of data items to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

removes netgate.vpp.prometheus.prometheusexporter.dataplanespace.Filters

list of data items to export

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/dataplane-space/filters"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.vpp.prometheus.prometheusexporter.HostSpace

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/host-space"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-vpp-prometheus:host-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}

creates netgate.vpp.prometheus.prometheusexporter.HostSpace

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.HostSpace to be added to list

object (netgate.vpp.prometheus.prometheusexporter.hostspace.Filters)

list of data items to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

creates or updates netgate.vpp.prometheus.prometheusexporter.HostSpace

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.HostSpace to be added or updated

object (netgate.vpp.prometheus.prometheusexporter.HostSpace)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:host-space": {"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}
}

removes netgate.vpp.prometheus.prometheusexporter.HostSpace

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/host-space"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.vpp.prometheus.prometheusexporter.hostspace.Filters

list of data items to export

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/host-space/filters"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

creates netgate.vpp.prometheus.prometheusexporter.hostspace.Filters

list of data items to export

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.hostspace.Filters to be added to list

netgate-vpp-prometheus:filter

Array of strings

regular expression for data to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filter": ["string"
]
}

creates or updates netgate.vpp.prometheus.prometheusexporter.hostspace.Filters

list of data items to export

Request Body schema: application/yang-data+json

netgate.vpp.prometheus.prometheusexporter.hostspace.Filters to be added or updated

object (netgate.vpp.prometheus.prometheusexporter.hostspace.Filters)

list of data items to export

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-vpp-prometheus:filters": {"netgate-vpp-prometheus:filter": ["string"
]
}
}

removes netgate.vpp.prometheus.prometheusexporter.hostspace.Filters

list of data items to export

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-vpp-prometheus:prometheus-exporter/host-space/filters"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

prometheus-control

operates on netgate.vpp.prometheus.PrometheusControl

Request Body schema: application/yang-data+json

object (netgate.vpp.prometheus.prometheuscontrol.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-vpp-prometheus:namespace": "host",
"netgate-vpp-prometheus:operation": "start"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-vpp-prometheus:stdout": "string"
}
}