netgate-pki API (24.06)

This YANG module provides specifications of operations and data related to PKI management on TNSR.

pki-all-restconf-cert

operates on netgate.pki.PkiAllRestconfCert

Request Body schema: application/yang-data+json

object (netgate.pki.pkiallrestconfcert.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:length": 0,
"netgate-pki:subject-alt-name": ["string"
]
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-ca-append

operates on netgate.pki.PkiCaAppend

Request Body schema: application/yang-data+json

object (netgate.pki.pkicaappend.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:source-name": "string"
}
}

pki-ca-delete

operates on netgate.pki.PkiCaDelete

Request Body schema: application/yang-data+json

object (netgate.pki.pkicadelete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

pki-ca-get

operates on netgate.pki.PkiCaGet

Request Body schema: application/yang-data+json

object (netgate.pki.pkicaget.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:output-level": 0,
"netgate-pki:name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-ca-import

operates on netgate.pki.PkiCaImport

Request Body schema: application/yang-data+json

object (netgate.pki.pkicaimport.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:contents": "string"
}
}

pki-ca-list

/operations/netgate-pki:pki-ca-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-ca-list"

	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-pki:name": ["string"
]
}
}

pki-ca-status-list

/operations/netgate-pki:pki-ca-status-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-ca-status-list"

	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-pki:entry": [{"netgate-pki:seconds-left": 0,
"netgate-pki:name": "string",
"netgate-pki:days-left": 0,
"netgate-pki:not-after": "string"
}
]
}
}

pki-cert-delete

operates on netgate.pki.PkiCertDelete

Request Body schema: application/yang-data+json

object (netgate.pki.pkicertdelete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

pki-cert-get

operates on netgate.pki.PkiCertGet

Request Body schema: application/yang-data+json

object (netgate.pki.pkicertget.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:output-level": 0,
"netgate-pki:name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-cert-import

operates on netgate.pki.PkiCertImport

Request Body schema: application/yang-data+json

object (netgate.pki.pkicertimport.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:contents": "string"
}
}

pki-cert-list

/operations/netgate-pki:pki-cert-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-cert-list"

	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-pki:name": ["string"
]
}
}

pki-cert-status-list

/operations/netgate-pki:pki-cert-status-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-cert-status-list"

	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-pki:entry": [{"netgate-pki:seconds-left": 0,
"netgate-pki:name": "string",
"netgate-pki:days-left": 0,
"netgate-pki:not-after": "string"
}
]
}
}

pki-csr-delete

operates on netgate.pki.PkiCsrDelete

Request Body schema: application/yang-data+json

object (netgate.pki.pkicsrdelete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

pki-csr-generate

operates on netgate.pki.PkiCsrGenerate

Request Body schema: application/yang-data+json

object (netgate.pki.pkicsrgenerate.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:org-unit": "string",
"netgate-pki:country": "string",
"netgate-pki:subject-alt-names": {"netgate-pki:subject-alt-name": [{"netgate-pki:index": 0,
"netgate-pki:hostname": "string",
"netgate-pki:ipv4-address": "string",
"netgate-pki:uri": "string",
"netgate-pki:email": "string",
"netgate-pki:ipv6-address": "string"
}
]
},
"netgate-pki:purpose": "ca",
"netgate-pki:org": "string",
"netgate-pki:city": "string",
"netgate-pki:digest": "sha224",
"netgate-pki:name": "string",
"netgate-pki:state": "string",
"netgate-pki:common-name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-csr-get

operates on netgate.pki.PkiCsrGet

Request Body schema: application/yang-data+json

object (netgate.pki.pkicsrget.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-csr-list

/operations/netgate-pki:pki-csr-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-csr-list"

	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-pki:name": ["string"
]
}
}

pki-csr-sign

operates on netgate.pki.PkiCsrSign

Request Body schema: application/yang-data+json

object (netgate.pki.pkicsrsign.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:digest": "sha224",
"netgate-pki:name": "string",
"netgate-pki:days-valid": 365,
"netgate-pki:purpose": "ca",
"netgate-pki:ca-name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-p12-delete

operates on netgate.pki.PkiP12Delete

Request Body schema: application/yang-data+json

object (netgate.pki.pkip12delete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

pki-p12-generate

operates on netgate.pki.PkiP12Generate

Request Body schema: application/yang-data+json

object (netgate.pki.pkip12generate.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:key-pbe-algorithm": "PBE-SHA1-3DES",
"netgate-pki:export-password": "string",
"netgate-pki:mac-algorithm": "sha1",
"netgate-pki:certificate-pbe-algorithm": "PBE-SHA1-3DES",
"netgate-pki:ca-name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:base64": "string"
}
}

pki-p12-get

operates on netgate.pki.PkiP12Get

Request Body schema: application/yang-data+json

object (netgate.pki.pkip12get.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:base64": "string"
}
}

pki-p12-list

/operations/netgate-pki:pki-p12-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-p12-list"

	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-pki:name": ["string"
]
}
}

pki-private-key-delete

operates on netgate.pki.PkiPrivateKeyDelete

Request Body schema: application/yang-data+json

object (netgate.pki.pkiprivatekeydelete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

pki-private-key-generate

operates on netgate.pki.PkiPrivateKeyGenerate

Request Body schema: application/yang-data+json

object (netgate.pki.pkiprivatekeygenerate.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:length": 0,
"netgate-pki:name": "string",
"netgate-pki:algorithm": "RSA"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-private-key-get

operates on netgate.pki.PkiPrivateKeyGet

Request Body schema: application/yang-data+json

object (netgate.pki.pkiprivatekeyget.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:stdout": "string"
}
}

pki-private-key-import

operates on netgate.pki.PkiPrivateKeyImport

Request Body schema: application/yang-data+json

object (netgate.pki.pkiprivatekeyimport.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:contents": "string"
}
}

pki-private-key-list

/operations/netgate-pki:pki-private-key-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-private-key-list"

	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-pki:name": ["string"
]
}
}

pki-ssh-key-delete

operates on netgate.pki.PkiSshKeyDelete

Request Body schema: application/yang-data+json

object (netgate.pki.pkisshkeydelete.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:which-keys": "private"
}
}

pki-ssh-key-get

operates on netgate.pki.PkiSshKeyGet

Request Body schema: application/yang-data+json

object (netgate.pki.pkisshkeyget.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:which-keys": "private"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-pki:public-key": "string",
"netgate-pki:private-key": "string"
}
}

pki-ssh-key-import

operates on netgate.pki.PkiSshKeyImport

Request Body schema: application/yang-data+json

object (netgate.pki.pkisshkeyimport.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-pki:name": "string",
"netgate-pki:public-key": "string",
"netgate-pki:private-key": "string"
}
}

pki-ssh-key-list

/operations/netgate-pki:pki-ssh-key-list

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-pki:pki-ssh-key-list"

	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-pki:key": [{"netgate-pki:name": "string",
"netgate-pki:which-keys": "private"
}
]
}
}