# Certificate Template Version: 0.0.1 License: RUCKUS Cloud Privacy Policy ## Servers RUCKUS One API host for Asian region. ``` https://api.asia.ruckus.cloud ``` RUCKUS One API host for European region. ``` https://api.eu.ruckus.cloud ``` RUCKUS One API host for North American region. ``` https://api.ruckus.cloud ``` ## Security ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Certificate Template](https://docs.ruckus.cloud/_bundle/api/certificate-template-api-0.0.1.yaml) ## Server and Client Certificate APIs for server and client certificate management. ### Get certificate by ID - [GET /serverCertificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadcertpem.md): Retrieves a specific server or client certificate by ID. ### Download certificate private key - [POST /serverCertificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadservercertp12.md): Downloads the private key of a certificate. ### Delete certificate - [DELETE /serverCertificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/deletecert.md): Deletes a server or client certificate. ### Update certificate - [PATCH /serverCertificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/patchcert.md): Updates a server or client certificate. ### Get certificate by ID - [GET /certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadcertpem_1.md): Retrieves a specific server or client certificate by ID. ### Download certificate private key - [POST /certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadservercertp12_1.md): Downloads the private key of a certificate. ### Delete certificate - [DELETE /certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/deletecert_1.md): Deletes a server or client certificate. ### Update certificate - [PATCH /certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/patchcert_1.md): Updates a server or client certificate. ### Search certificates - [POST /serverCertificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/querycerts.md): Searches for server or client certificates matching the search criteria. ### Search certificates - [POST /certificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/querycerts_1.md): Searches for server or client certificates matching the search criteria. ### Upload certificate - [POST /serverCertificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/uploadcert.md): Uploads a server or client certificate. ### Upload certificate - [POST /certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/uploadcert_1.md): Uploads a server or client certificate. ### Search certificates by CA - [POST /certificateAuthorities/{caId}/serverCertificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/getbycaid.md): Searches for certificates issued by a specific certificate authority. ### Search certificates by CA - [POST /certificateAuthorities/{caId}/certificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/getbycaid_1.md): Searches for certificates issued by a specific certificate authority. ### Create certificate - [POST /certificateAuthorities/{caId}/serverCertificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/createcert.md): Creates a new server or client certificate. ### Create certificate - [POST /certificateAuthorities/{caId}/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/createcert_1.md): Creates a new server or client certificate. ### Download certificate chain - [GET /certificates/{certId}/chains](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadservercertchaininpkcs7.md): Downloads the certificate chain in PEM format. ### Download certificate chain - [GET /serverCertificates/{certId}/chains](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/downloadservercertchaininpkcs7_1.md): Downloads the certificate chain in PEM format. ### Get certificates by RADIUS - [GET /radiusProfiles/{radiusProfileId}/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/server-and-client-certificate/getcertificatesbyradiusid.md): Retrieves certificates associated with a RADIUS profile. ## Device Certificate APIs for device certificate management. ### Generate certificate for identity - [POST /certificateTemplates/{templateId}/identities/{identityId}/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/generatecerttoidentity.md): Generates a certificate for a specific identity. ### Search certificates by identity - [POST /certificateTemplates/{templateId}/identities/{identityId}/certificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/getcertsbyidentity.md): Searches for certificates associated with a specific identity. ### Generate certificates for identities - [POST /certificateTemplates/{templateId}/identities/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/generatecertsforidentities.md): Generates certificates for multiple identities. ### Generate Certificate - [POST /certificateTemplates/{templateId}/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/generatecert.md): Generates a new certificate. ### Delete certificates - [DELETE /certificateTemplates/{templateId}/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/deletecerts.md): Deletes multiple certificates in bulk. ### Get certificate by ID - [GET /certificateTemplates/{templateId}/certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/downloadcertder.md): Retrieves a specific certificate by ID. ### Download certificate private key - [POST /certificateTemplates/{templateId}/certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/downloadcertp12.md): Downloads the private key of an issued certificate. ### Update certificate - [PATCH /certificateTemplates/{templateId}/certificates/{certId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/patchcert_2.md): Updates a device certificate with the provided changes. ### Search certificates in template - [POST /certificateTemplates/{templateId}/certificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/querycerts_2.md): Searches for certificates in a specific template matching the search criteria. ### Search certificates - [POST /certificateTemplates/certificates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/queryallcerts.md): Searches for certificates matching the search criteria. ### Download certificate chain - [GET /certificateTemplates/{templateId}/certificates/{certId}/chains](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/device-certificate/downloadcertchaininpkcs7.md): Downloads the certificate chain in PEM format. ## Certificate Authority APIs for certificate authority management. ### Create certificate authority - [POST /certificateAuthorities](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/uploadca.md): Creates a new certificate authority. ### Get certificate authority by ID - [GET /certificateAuthorities/{caId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/downloadcader.md): Retrieves a specific certificate authority by ID. ### Download CA private key - [POST /certificateAuthorities/{caId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/downloadcap12.md): Downloads the private key of certificate authority. ### Delete certificate authority - [DELETE /certificateAuthorities/{caId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/deleteca.md): Deletes a certificate authority. ### Update certificate authority - [PATCH /certificateAuthorities/{caId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/patchca.md): Updates a certificate authority. ### Create template for CA - [POST /certificateAuthorities/{caId}/templates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/createtemplatewithonboardca.md): Creates a new certificate template for a specific certificate authority. ### Search templates for CA - [POST /certificateAuthorities/{caId}/templates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/querytemplatesbyca.md): Searches for templates belonging to a specific certificate authority. ### Create sub certificate authority - [POST /certificateAuthorities/{caId}/subCas](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/createsubca.md): Creates a new sub certificate authority. ### Search sub certificate authorities - [POST /certificateAuthorities/{caId}/subCas/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/querysubcas.md): Searches for sub certificate authorities matching the search criteria. ### Upload CA private key - [POST /certificateAuthorities/{caId}/privateKeys](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/uploadcaprivatekey.md): Uploads the private key for a certificate authority. ### Delete CA private key - [DELETE /certificateAuthorities/{caId}/privateKeys](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/deletecaprivatekey.md): Deletes the private key for a certificate authority. ### Search certificate authorities - [POST /certificateAuthorities/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/querycas.md): Searches for certificate authorities matching the search criteria. ### Get CAs by RADIUS - [GET /radiusProfiles/{radiusProfileId}/certificateAuthorities](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/getcasbyradiusid.md): Retrieves certificate authorities associated with a RADIUS profile. ### Download CA certificate chain - [GET /certificateAuthorities/{caId}/chains](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-authority/downloadcachainpkcs7.md): Downloads the certificate chain of a certificate authority in PEM format. ## Certificate Template APIs for certificate template management. ### Update template policy set - [PUT /certificateTemplates/{templateId}/policySets/{policySetId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/certtempupdatepolicysetid.md): Updates the policy set for a certificate template. ### Remove template policy set - [DELETE /certificateTemplates/{templateId}/policySets/{policySetId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/certtempremovepolicysetid.md): Removes the policy set from a certificate template. ### Get template scep keys - [GET /certificateTemplates/{templateId}/scepKeys](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getscepkeys.md): Retrieves all SCEP keys for a certificate template. ### Create scep key - [POST /certificateTemplates/{templateId}/scepKeys](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/createscepkey.md): Creates a simple certificate enrollment protocol key for a certificate template. ### Get template notifications - [GET /certificateTemplates/{templateId}/notifications](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getnotifications.md): Retrieves all notifications for a certificate template. ### Create notification for template - [POST /certificateTemplates/{templateId}/notifications](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/createnotification.md): Creates a notification for a certificate template. ### Get template msi packages - [GET /certificateTemplates/{templateId}/msiPackages](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getmsipackages.md): Retrieves all MSI packages for a certificate template. ### Create msi package - [POST /certificateTemplates/{templateId}/msiPackages](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/createmsipackage.md): Creates a microsoft software installer package for a certificate template. ### Search certificate templates - [POST /certificateTemplates/query](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/querytemplates.md): Searches for certificate templates matching the search criteria. ### Get certificate template by ID - [GET /certificateTemplates/{templateId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/gettemplatebyid.md): Retrieves a specific certificate template by ID. ### Delete certificate template - [DELETE /certificateTemplates/{templateId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/deletetemplate.md): Deletes a certificate template. ### Update certificate template - [PATCH /certificateTemplates/{templateId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/patchtemplate.md): Updates a certificate template. ### Get scep key by ID - [GET /certificateTemplates/{templateId}/scepKeys/{scepKeyId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getscepkeybyid.md): Retrieves a specific SCEP key by ID. ### Delete scep key - [DELETE /certificateTemplates/{templateId}/scepKeys/{scepKeyId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/deletescepkey.md): Deletes a SCEP key from a certificate template. ### Update scep key - [PATCH /certificateTemplates/{templateId}/scepKeys/{scepKeyId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/patchscepkey.md): Updates a SCEP key for a certificate template. ### Get notification by ID - [GET /certificateTemplates/{templateId}/notifications/{notificationId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getnotificationbyid.md): Retrieves a specific notification by ID. ### Delete notification - [DELETE /certificateTemplates/{templateId}/notifications/{notificationId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/deletenotification.md): Deletes a notification from a certificate template. ### Update template notification - [PATCH /certificateTemplates/{templateId}/notifications/{notificationId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/patchnotification.md): Updates a notification for a certificate template. ### Get msi package by ID - [GET /certificateTemplates/{templateId}/msiPackages/{msiPackageId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/getmsipackagebyid.md): Retrieves a specific MSI package by ID. ### Delete msi package - [DELETE /certificateTemplates/{templateId}/msiPackages/{msiPackageId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/deletemsipackage.md): Deletes an MSI package from a certificate template. ### Update msi package - [PATCH /certificateTemplates/{templateId}/msiPackages/{msiPackageId}](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/patchmsipackage.md): Updates an MSI package for a certificate template. ### Get templates by network - [GET /wifiNetworks/{networkId}/certificateTemplates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/certificate-template/gettemplatebynetworkid.md): Retrieves certificate templates associated with a network. ## system-controller ### generateCertByDefaultCa - [POST /systems/certificates](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/system-controller/generatecertbydefaultca.md) ### queryDefaultCa - [GET /systems/certificateAuthorities](https://docs.ruckus.cloud/api/certificate-template-api-0.0.1/system-controller/querydefaultca.md)