Using the Hub Certificate REST API

The Hub Certificate REST API is used to upload and manage Hub certificates. In addition to the POST and PATCH methods shown in the examples below, there are also GET and DELETE methods available for this REST API.

For the permissions required to access the Hub Certificate REST API, see Role Permissions for Intelligent Advisor REST APIs.

Example POST a Hub certificate

This operation will upload a Hub certificate.

The POST request URL looks like:

/opa-hub/api/12.2.39/hubcertificates

To POST a certificate, you need to specify a key id and the PEM data containing the private key and certificate key.

For example, a request to post a Hub certificate looks like the following:

{
    "keyId": "ee9abb367ad142fe8a09d91b9d98e3bf",
    "privateKeyPemData": "MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDubrh537qlFj2e\nZ6YkSl8wZ5Y4ffEod+aGcDU5UVrRCZQA2eZrzNbnXAWUR8xSTJ6iiY6f9dQqnUGy\nrsdGwT4JNSn9HispagLea+3Jm/l/zpZrsNnKzlyH2kDmFu25pRYypoxuwvTMLTOm\nUQXdBfPp62r4PxIsBSGuWWDamsEaaDGxLLJ48FZQ0DNbLUola3bkUcqo3C+PYrRo\n0HkeA2LVvpaSzmZuF7STIIFXqUtKDyj0HcBDQiOO7LNHK6nGTsWVG/u6QIHWS2M5\n42b1actmCH7FXeFEV42E7O8wOtVLFy1tM1bGLbZXFpiiPDuXvjaUGWIwDRoT35yM\ns+F/fuCrAgMBAAECggEAbm4eh+fcyNBLur2TwBQoEUGw3DpMgutBfDulEwaAkvem\nMly5sWz+jcpblSlJ00ZEZNBkG+ceHJyYDJuRlU40HsyeRWr/H5/Hc1+2kt1oSc8T\ncQ5IWPuJ9KvbyhWNhiGVbeEggr5N5fD7jojRN+Sla06LTS3dC0FXL6qaxrTNQh5i\nD8FJ1gf6LJU2AhFPnWVfNY+L4bMTQr+GQsRXtZPCy5KIQB6VPg/Ife0+FeougEJy\nhLK9F4bb61W7IHhoZsFEp7pVLv5DCuTeQocXlmop9VYOlBXjOdwCoWCRuLUuHG8n\nE9x7xV64Nku2J7ipT+efyjrFqeyQSgLdF4LG0JvB9QKBgQDwRbfbwm3CAHrZacXw\nJsVUkfTU5TuitKkA/gAejQsMg/IrPZ3nmvZ9Gq2DFw9K3KwLrig73QvAP+7D33uv\nBiWt8WFBsEe4+TX8bz9pobnOEuRZ5ZWH/SDnG6hDflXQAo1e+tDgqi3efHjZU2sk\nKwIGvo0mo85jIC6rbWGUEw+9pQKBgQD+CiwJO9xi9kbQjTFpILFWcsbg2IxFZ0du\n8IQ3agwxGQF3Uxc9uMk8yU2zzOCF2236qc+ITUyJM1+p93K1OVV7IovwqsljxMpU\nYZFC0G6Trlqw/HiS1WdaHDSdpmiMtv3JLOwMK/Xx+3NB6IB2bsOWBFfSGcXyc+yG\n4pb299R0DwKBgQDs7cLUuJAk2vZJR81A9+pkb5z/BqDc28s/yDhz5986Uy5NR3Bb\nP2rKiLEK8IVK6/nXdsAD8AAzbpfSnKDJQYWMVdbywJKpK036A/WDA1BGjkiRARyH\nwatdWd991qll+e5P94Jb2FRs7U759xFS0/omjmZ/8M2G3+hFcRHkwzslZQKBgQDM\nucfZPSuTeSOCiHbMYPNpVqAdrYYFnIC90AjNW6ItoxhCYGz3acaLPTNodfBvD3In\nMtgz4Q+P9h3fLLJ9h5Hy5Nlf/1LDG2Fu9R4KeUzTqQwfW6eTtXVP8jEY53WUCRin\nGpO0D21qMJknAUcdqo/mguN/RxP2GyP/Y/YDW6AUUwKBgFLq2uuBV5mZyvG8oui1\n9/sIuaJurBPC/vm09/7RDEXHkHnu2g9KipZ+l6BkFGA+Aa0mZO1I1c3/9FG3Mv4F\n482p67dMiKaMe2MX46b4Efqarxn7S6Gc0HoHBPJWyKLvEA86ghHnGUCyLl+Rhgub\nyhAHK3ocTyoqREJ+DIebFgRd",
    "x5cPemData": "-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIUSPvXPsnxWhLvi6pw3tOnFwggVYYwDQYJKoZIhvcNAQEL\nBQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM\nGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNDAzMDUyMTU4MzRaFw0yNDA0\nMTQyMTU4MzRaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw\nHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQDubrh537qlFj2eZ6YkSl8wZ5Y4ffEod+aGcDU5UVrR\nCZQA2eZrzNbnXAWUR8xSTJ6iiY6f9dQqnUGyrsdGwT4JNSn9HispagLea+3Jm/l/\nzpZrsNnKzlyH2kDmFu25pRYypoxuwvTMLTOmUQXdBfPp62r4PxIsBSGuWWDamsEa\naDGxLLJ48FZQ0DNbLUola3bkUcqo3C+PYrRo0HkeA2LVvpaSzmZuF7STIIFXqUtK\nDyj0HcBDQiOO7LNHK6nGTsWVG/u6QIHWS2M542b1actmCH7FXeFEV42E7O8wOtVL\nFy1tM1bGLbZXFpiiPDuXvjaUGWIwDRoT35yMs+F/fuCrAgMBAAGjUzBRMB0GA1Ud\nDgQWBBQp5OUKL1P0GCdZqnxfb1sDHRgBvzAfBgNVHSMEGDAWgBQp5OUKL1P0GCdZ\nqnxfb1sDHRgBvzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAp\n1bthrdLol+lmAeeQUKapGTwA0IrL/2zQrkqkOXtLXumUGemfvho6XCoPea4gdu9p\nmaxnVNIevKoJMK+n426V070Zjycqx88B/WZsf7dc2WZUBmEtE4RBaQ+ttt+c4vCs\nwWKysfMCZu4beuCYsDspzpT/b/bta8Xfp8lii24vI+YY4oDga4atxLj+m6S2lIi+\noRwRX/iP0hDQjCUgS5NR0MPOJIaqSpCAb+CvStyjirn3r+ZHuZdoMhqdYjCbZgyj\njBkNitjeAIGUU3fxXNSa+Zuth1wpItFVjL/CESBT5ryPBTNEHbG5WebSG9c2VG5L\nm376cSTFx94ahklE05q9\n-----END CERTIFICATE-----"
}
            

Example PATCH the status of a Hub certificate

This operation will set the status of the Hub certificate.

The PATCH request URL looks like:

/opa-hub/api/12.2.39/hubcertificates/{keyId}

An example of setting the Hub certificate to active would be:

{
    "status": true
}