netgate-conf-history API (22.06)

Definitions of configuration history feature data and operations. Copyright 2021 Rubicon Communications, LLC. All rights reserved.

conf-history-config

returns netgate.conf.history.ConfHistoryConfig

get /data/netgate-conf-history:conf-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config

returns netgate.conf.history.ConfHistoryConfig

Responses

200

netgate.conf.history.ConfHistoryConfig

400

Internal error

Request samples

Copy
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

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:conf-history-config":
    {
    }
}

creates netgate.conf.history.ConfHistoryConfig

post /data/netgate-conf-history:conf-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config

creates netgate.conf.history.ConfHistoryConfig

Request Body schema: application/yang-data+json

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

version-history-config
object (netgate.conf.history.confhistoryconfig.VersionHistoryConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "version-history-config":
    {
    }
}

creates or updates netgate.conf.history.ConfHistoryConfig

put /data/netgate-conf-history:conf-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config

creates or updates netgate.conf.history.ConfHistoryConfig

Request Body schema: application/yang-data+json

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

netgate-conf-history:conf-history-config
object (netgate.conf.history.ConfHistoryConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:conf-history-config":
    {
    }
}

removes netgate.conf.history.ConfHistoryConfig

delete /data/netgate-conf-history:conf-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config

removes netgate.conf.history.ConfHistoryConfig

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

returns netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Responses

200

netgate.conf.history.confhistoryconfig.VersionHistoryConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history: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

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:version-history-config":
    {
    }
}

creates netgate.conf.history.confhistoryconfig.VersionHistoryConfig

post /data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

creates netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Request Body schema: application/yang-data+json

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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "conf-history-autosave-period": 0,
  • "conf-history-enabled": true
}

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

put /data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

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

netgate-conf-history:version-history-config
object (netgate.conf.history.confhistoryconfig.VersionHistoryConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:version-history-config":
    {
    }
}

removes netgate.conf.history.confhistoryconfig.VersionHistoryConfig

delete /data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history:version-history-config

removes netgate.conf.history.confhistoryconfig.VersionHistoryConfig

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-config/netgate-conf-history: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

get /data/netgate-conf-history:conf-history-state

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-state

returns netgate.conf.history.ConfHistoryState

Responses

200

netgate.conf.history.ConfHistoryState

400

Internal error

Request samples

Copy
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

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:conf-history-state":
    {
    }
}

returns netgate.conf.history.confhistorystate.VersionHistoryConfig

get /data/netgate-conf-history:conf-history-state/netgate-conf-history:version-history-config

Example URL

https://hostname/restconf/data/netgate-conf-history:conf-history-state/netgate-conf-history:version-history-config

returns netgate.conf.history.confhistorystate.VersionHistoryConfig

Responses

200

netgate.conf.history.confhistorystate.VersionHistoryConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-conf-history:conf-history-state/netgate-conf-history: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

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "netgate-conf-history:version-history-config":
    {
    }
}

conf-history-diff-versions

creates netgate.conf.history.ConfHistoryDiffVersions

post /operations/netgate-conf-history:conf-history-diff-versions

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-diff-versions

creates netgate.conf.history.ConfHistoryDiffVersions

Request Body schema: application/yang-data+json
input
object (netgate.conf.history.confhistorydiffversions.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "output":
    {
    }
}

conf-history-drop-versions

creates netgate.conf.history.ConfHistoryDropVersions

post /operations/netgate-conf-history:conf-history-drop-versions

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-drop-versions

creates netgate.conf.history.ConfHistoryDropVersions

Request Body schema: application/yang-data+json
input
object (netgate.conf.history.confhistorydropversions.Input)

Responses

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "input":
    {
    }
}

conf-history-get-log

creates netgate.conf.history.ConfHistoryGetLog

post /operations/netgate-conf-history:conf-history-get-log

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-get-log

creates netgate.conf.history.ConfHistoryGetLog

Request Body schema: application/yang-data+json
input
object (netgate.conf.history.confhistorygetlog.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "output":
    {
    }
}

conf-history-get-versions

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-get-versions

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Copy
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

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "output":
    {
    }
}

conf-history-load-version

creates netgate.conf.history.ConfHistoryLoadVersion

post /operations/netgate-conf-history:conf-history-load-version

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-load-version

creates netgate.conf.history.ConfHistoryLoadVersion

Request Body schema: application/yang-data+json
input
object (netgate.conf.history.confhistoryloadversion.Input)

Responses

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "input":
    {
    }
}

conf-history-save-version

creates netgate.conf.history.ConfHistorySaveVersion

post /operations/netgate-conf-history:conf-history-save-version

Example URL

https://hostname/restconf/operations/netgate-conf-history:conf-history-save-version

creates netgate.conf.history.ConfHistorySaveVersion

Request Body schema: application/yang-data+json
input
object (netgate.conf.history.confhistorysaveversion.Input)

Responses

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
Expand all Collapse all
{
  • "input":
    {
    }
}