netgate-conf-history API (24.10)

conf-history-config

returns netgate.conf.history.ConfHistoryConfig

Config database archive configurations.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config"

	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-conf-history:conf-history-config": {"netgate-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}
}

creates netgate.conf.history.ConfHistoryConfig

Config database archive configurations.

Request Body schema: application/yang-data+json

netgate.conf.history.ConfHistoryConfig to be added to list

object (netgate.conf.history.confhistoryconfig.VersionHistoryConfig)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}

creates or updates netgate.conf.history.ConfHistoryConfig

Config database archive configurations.

Request Body schema: application/yang-data+json

netgate.conf.history.ConfHistoryConfig to be added or updated

object (netgate.conf.history.ConfHistoryConfig)

Config database archive configurations.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-conf-history:conf-history-config": {"netgate-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}
}

removes netgate.conf.history.ConfHistoryConfig

Config database archive configurations.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config"

	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.conf.history.confhistoryconfig.VersionHistoryConfig

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config/version-history-config"

	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-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}

creates netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Request Body schema: application/yang-data+json

netgate.conf.history.confhistoryconfig.VersionHistoryConfig to be added to list

netgate-conf-history:conf-history-autosave-period	integer <int64>
netgate-conf-history:conf-history-enabled	boolean Default: true

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}

creates or updates netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Request Body schema: application/yang-data+json

netgate.conf.history.confhistoryconfig.VersionHistoryConfig to be added or updated

object (netgate.conf.history.confhistoryconfig.VersionHistoryConfig)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}

removes netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config/version-history-config"

	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))

}

conf-history-state

returns netgate.conf.history.ConfHistoryState

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-state"

	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-conf-history:conf-history-state": {"netgate-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}
}

returns netgate.conf.history.confhistorystate.VersionHistoryConfig

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-state/version-history-config"

	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-conf-history:version-history-config": {"netgate-conf-history:conf-history-autosave-period": 0,
"netgate-conf-history:conf-history-enabled": true
}
}

conf-history-diff-versions

operates on netgate.conf.history.ConfHistoryDiffVersions

Request Body schema: application/yang-data+json

object (netgate.conf.history.confhistorydiffversions.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-conf-history:version2": "string",
"netgate-conf-history:version1": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-conf-history:plain-diff": "string"
}
}

conf-history-drop-versions

operates on netgate.conf.history.ConfHistoryDropVersions

Request Body schema: application/yang-data+json

object (netgate.conf.history.confhistorydropversions.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-conf-history:version-name": "string"
}
}

conf-history-get-log

operates on netgate.conf.history.ConfHistoryGetLog

Request Body schema: application/yang-data+json

object (netgate.conf.history.confhistorygetlog.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-conf-history:commit-header": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-conf-history:logs": {"netgate-conf-history:log": [{"netgate-conf-history:commit": "string"
}
]
}
}
}

conf-history-get-versions

/operations/netgate-conf-history:conf-history-get-versions

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-conf-history:conf-history-get-versions"

	req, _ := http.NewRequest("POST", 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

{"output": {"netgate-conf-history:versions": {"netgate-conf-history:version": [{"netgate-conf-history:version-name": "string"
}
]
}
}
}

conf-history-load-version

operates on netgate.conf.history.ConfHistoryLoadVersion

Request Body schema: application/yang-data+json

object (netgate.conf.history.confhistoryloadversion.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-conf-history:version-name": "string"
}
}

conf-history-save-version

operates on netgate.conf.history.ConfHistorySaveVersion

Request Body schema: application/yang-data+json

object (netgate.conf.history.confhistorysaveversion.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-conf-history:version-name": "string"
}
}