Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-pki API (24.02)

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

Copyright 2018-2022 Rubicon Communications, LLC.

pki-all-restconf-cert

operates on netgate.pki.PkiAllRestconfCert

post /operations/netgate-pki:pki-all-restconf-cert

Example URL

https://hostname/restconf/operations/netgate-pki:pki-all-restconf-cert

operates on netgate.pki.PkiAllRestconfCert

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkiallrestconfcert.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":
    {
    }
}

pki-ca-append

operates on netgate.pki.PkiCaAppend

post /operations/netgate-pki:pki-ca-append

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-append

operates on netgate.pki.PkiCaAppend

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicaappend.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-ca-delete

operates on netgate.pki.PkiCaDelete

post /operations/netgate-pki:pki-ca-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-delete

operates on netgate.pki.PkiCaDelete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicadelete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-ca-get

operates on netgate.pki.PkiCaGet

post /operations/netgate-pki:pki-ca-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-get

operates on netgate.pki.PkiCaGet

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicaget.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":
    {
    }
}

pki-ca-import

operates on netgate.pki.PkiCaImport

post /operations/netgate-pki:pki-ca-import

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-import

operates on netgate.pki.PkiCaImport

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicaimport.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-ca-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-list

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

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

pki-ca-status-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ca-status-list

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

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

pki-cert-delete

operates on netgate.pki.PkiCertDelete

post /operations/netgate-pki:pki-cert-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-cert-delete

operates on netgate.pki.PkiCertDelete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicertdelete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-cert-get

operates on netgate.pki.PkiCertGet

post /operations/netgate-pki:pki-cert-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-cert-get

operates on netgate.pki.PkiCertGet

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicertget.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":
    {
    }
}

pki-cert-import

operates on netgate.pki.PkiCertImport

post /operations/netgate-pki:pki-cert-import

Example URL

https://hostname/restconf/operations/netgate-pki:pki-cert-import

operates on netgate.pki.PkiCertImport

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicertimport.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-cert-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-cert-list

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

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

pki-cert-status-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-cert-status-list

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

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

pki-csr-delete

operates on netgate.pki.PkiCsrDelete

post /operations/netgate-pki:pki-csr-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-csr-delete

operates on netgate.pki.PkiCsrDelete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicsrdelete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-csr-generate

operates on netgate.pki.PkiCsrGenerate

post /operations/netgate-pki:pki-csr-generate

Example URL

https://hostname/restconf/operations/netgate-pki:pki-csr-generate

operates on netgate.pki.PkiCsrGenerate

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicsrgenerate.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":
    {
    }
}

pki-csr-get

operates on netgate.pki.PkiCsrGet

post /operations/netgate-pki:pki-csr-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-csr-get

operates on netgate.pki.PkiCsrGet

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicsrget.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":
    {
    }
}

pki-csr-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-csr-list

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

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

pki-csr-sign

operates on netgate.pki.PkiCsrSign

post /operations/netgate-pki:pki-csr-sign

Example URL

https://hostname/restconf/operations/netgate-pki:pki-csr-sign

operates on netgate.pki.PkiCsrSign

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkicsrsign.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":
    {
    }
}

pki-p12-delete

operates on netgate.pki.PkiP12Delete

post /operations/netgate-pki:pki-p12-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-p12-delete

operates on netgate.pki.PkiP12Delete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkip12delete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-p12-generate

operates on netgate.pki.PkiP12Generate

post /operations/netgate-pki:pki-p12-generate

Example URL

https://hostname/restconf/operations/netgate-pki:pki-p12-generate

operates on netgate.pki.PkiP12Generate

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkip12generate.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":
    {
    }
}

pki-p12-get

operates on netgate.pki.PkiP12Get

post /operations/netgate-pki:pki-p12-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-p12-get

operates on netgate.pki.PkiP12Get

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkip12get.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":
    {
    }
}

pki-p12-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-p12-list

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

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

pki-private-key-delete

operates on netgate.pki.PkiPrivateKeyDelete

post /operations/netgate-pki:pki-private-key-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-private-key-delete

operates on netgate.pki.PkiPrivateKeyDelete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkiprivatekeydelete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-private-key-generate

operates on netgate.pki.PkiPrivateKeyGenerate

post /operations/netgate-pki:pki-private-key-generate

Example URL

https://hostname/restconf/operations/netgate-pki:pki-private-key-generate

operates on netgate.pki.PkiPrivateKeyGenerate

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkiprivatekeygenerate.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":
    {
    }
}

pki-private-key-get

operates on netgate.pki.PkiPrivateKeyGet

post /operations/netgate-pki:pki-private-key-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-private-key-get

operates on netgate.pki.PkiPrivateKeyGet

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkiprivatekeyget.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":
    {
    }
}

pki-private-key-import

operates on netgate.pki.PkiPrivateKeyImport

post /operations/netgate-pki:pki-private-key-import

Example URL

https://hostname/restconf/operations/netgate-pki:pki-private-key-import

operates on netgate.pki.PkiPrivateKeyImport

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkiprivatekeyimport.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-private-key-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-private-key-list

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

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

pki-ssh-key-delete

operates on netgate.pki.PkiSshKeyDelete

post /operations/netgate-pki:pki-ssh-key-delete

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ssh-key-delete

operates on netgate.pki.PkiSshKeyDelete

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkisshkeydelete.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-ssh-key-get

operates on netgate.pki.PkiSshKeyGet

post /operations/netgate-pki:pki-ssh-key-get

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ssh-key-get

operates on netgate.pki.PkiSshKeyGet

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkisshkeyget.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":
    {
    }
}

pki-ssh-key-import

operates on netgate.pki.PkiSshKeyImport

post /operations/netgate-pki:pki-ssh-key-import

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ssh-key-import

operates on netgate.pki.PkiSshKeyImport

Request Body schema: application/yang-data+json
input
object (netgate.pki.pkisshkeyimport.Input)

Responses

201

No response

400

Internal error

Request samples

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

pki-ssh-key-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-pki:pki-ssh-key-list

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

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