createExternalCertificate

Article Summary

Share feedback

Thanks for sharing your feedback!

Overview

You can add SSL certificates issued by external certificate authorities.

Request

Method	Request URI
POST	`https://certificatemanager.apigw.ntruss.com/api/v1/certificate/withExternal`

Reqeust header

Header	Description
x-ncp-apigw-timestamp	It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
x-ncp-iam-access-key	API key issued by NAVER Cloud Platform or access key issued by IAM
x-ncp-apigw-signature-v2	Signature used to encrypt the body with the “secret key” that maps with the “access key.” The HMAC encryption algorithm is HMAC SHA256. Reference Call APIs that require IAM authentication
accept	Specify to `application/json`
Content-Type	Specify to `application/json`

Request parameters

Parameter	Required	Type	Constraints	Description
certificateName	Yes	String	Cannot be duplicated	Certificate name
privateKey	Yes	String	Cannot be duplicated	Private key of a certificate `Enter PEM–encoded value.`
publicKeyCertificate	Yes	String	Cannot be duplicated	Public key of a certificate `Enter PEM–encoded value.`
certificateChain	Yes	String	Cannot be duplicated	Certificate chain `Enter PEM–encoded value.` You can see how to export certificate chain in Certificate Manager Manual.

Response

Response body

Field	Type	Description
returnCode	String	Response code
returnMessage	String	Response message
totalRows	Integer	Number of objects in sslCertificateList
sslCertificateList[]	String	Information of the added certificate

Examples

Request example

curl -X POST "https://certificatemanager.apigw.ntruss.com/api/v1/certificate/withExternal" 
-H "accept: application/json" 
-H "Content-Type: application/json" 
-H "x-ncp-iam-access-key: 72A565A16F1827A27DD5" 
-H "x-ncp-apigw-timestamp: 1594649662877" 
-H "x-ncp-apigw-signature-v2: 1en0ujbwgX+UNEZ6JnWbxKJQjaf808InNpx7RGZJjCY=" 
-d "{ ""certificateChain"": ""-----BEGIN CERTIFICATE-----MIIFziCCA3OgAwIBAgIQBUb+GCP34ZQdo5/OFMRhczANBgkqhkiG9w0BAQsFADBhMQswCQYDVQQGEwJVUzEVMTMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBDQTAeFw0xNzExMDYxMjIzNDVaFw0yNzExMDYxMjIzNDVaMF4xCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xHTAbBgNVBAMTFEdlb1RydXN0IFJTQSBDQSAyMDE4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv4rRY03hGOqHXegWPI9/tr6HFzekDPgxP59FVEAh150Hm8oDI0q9m+2FAmM/n4W57Cjv8oYi2/hNVEHFtEJ/zzMXAQ6CkFLTxzSkwaEB2jKgQK0fWeQz/KDDlqxobNPomXOMJhB3y7c/OTLo0lko7geG4gk7hfiqafapa59YrXLIW4dmrgjgdPstU0Nigz2PhUwRl9we/FAwuIMIMl5cXMThdSBK66XWdS3cLX184ND+fHWhTkAChJrZDVouoKzzNYoq6tZaWmyOLKv23v14RyZ5eqoi6qnmcRID1/i6U9J5nL1krPYbY7tNjzgC+PBXXcWqJVoMXcUw/iBTGWzpwwIDAQABo4IBQDCCATwwHQYDVR0OBBYEFJBY/7CcdahRVHex7fKjQxY4nmzFMB8GA1UdIwQYMBaAFAPeUDVW0Uy7ZvCj4hsbw5eyPdFVMA4GA1UdDwEB/wQEAwIBhjAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwEgYDVR0TAQH/BAgwBgEB/wIBADA0BggrBgEFBQcBAQQoMCYwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsMy5kaWdpY2VydC5jb20vRGlnaUNlcnRHbG9iYWxSb290Q0EuY3JsMD0GA1UdIAQ2MDQwMgYEVR0gADAqMCgGCCsGAQUFBwIBFhxodHRwczovL3d3dy5kaWdpY2VydC5jb20vQ1BTMA0GCSqGSIb3DQEBCwUAA4IBAQAw8YdVPYQI/C5earp80s3VLOO+AtpdiXft9OlWwJLwKlUtRfccKj8QW/Pp4b7h6QAlufejwQMb455OjpIbCZVS+awY/R8pAYsXCnM09GcSVe4ivMswyoCZP/vPEn/LPRhHhdgUPk8MlD979RGoUWz7qGAwqJChi28uRds3thx+vRZZIbEyZ62No0tJPzsSGSz8nQ//jP8BIwrzBAUH5WcBAbmvgWfrKcuv+PyGPqRcc4T55TlzrBnzAzZ3oClo9fTvO9PuiHMKrC6V6mgi0s2sa/gbXlPCD9Z24XUMxJElwIVTDuKB0Q4YMMlnpN/QChJ4B0AFsQ+BgkqCO+f78Xf7-----END CERTIFICATE----------BEGIN CERTIFICATE-----MIIGrxCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBhMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBDQTAeFw0wNjExMTAwMDAwMDBaFw0zMTExMTAwMDAwMDBaMGExCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydA5jb20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4jvhEXLeqKTTo1eqUKKPC3eQyaKl7jPQ3lsBCSDMAZOnTjC3U/dDxGkAV53ijSLdhwZAAIEJzs4bg7/fzTtxRuLWZscFs3YnFo97nh6Vfe63SKMI2tavegw5BmV/Sl0fvBf4q77uKNd0f3p4mVmFaG5cIzJLv07A6Fpt43C/dxC//AH2hdmoRBBYMql1GNXRor5H4idq9Joz+EkIYIvUX7Q6hL+hqkpMfT7PT19sdl6gSzeRntwi5m3OFBqOasv+zbMUZBfHWymeMr/y7vrTC0LUq7dBMtoM1O/4gdW7jVg/tRvoSSiicNoxZN33shbyTApOB6jtSj1etX+jkMOvJwIDAQABo2MwYTAOBgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUA95QNVbRTLtm8KPiGxvDl7I90VUwHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUwDQYJKoZIhvcNAQEFBQADggEBAMucN6pIExIK+t1EnE9SsPTfrgT1eXkIoyQY/EsrhMAtudXH/vTBH1jLuG2cenTnmCmrEbXjcKChzUyImZOMkXDiqw8cvpOp/2PV5Adg06O/nVsJ8dWO41P0jmP6P6fbtGbfYmbW0W5BjfIttep3Sp+dWOIrWcBAI+0tKIJFPnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0lsYSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQkCAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4=-----END CERTIFICATE-----"", 
""certificateName"": ""CM-openAPI"", 
""privateKey"": ""-----BEGIN RSA PRIVATE KEY-----MIIEpIQABBKCAQEAivoZ5cI47dY8yJM4ueGsdeWhzyki/+6vNhxmueW4+CJMzX+L6ym7h3YLNKyBgptU++1cdfbcJuOGYtzXxn+tsKwzYxb8L4cKKQP4Jjgegv8fmmRMaQBFOvNT3JhhvBgMC1rMLGaRj0jnLo/9KO6QJl9A6WRSGVqVi0c6HMr7VYVP/CFKQCRn6wMmIZ0oUpmU04AvcyyoDbagr1acwDkhs3k+fEG2dgGZXDiHzFImfTQvIto8bc6Um6n8YoK2YjO8/DRbwZRmU8gNGfOr6C+i88EwU4Mym7S0FLyGgNzq4NwoKL0KUar5b96GGc1BPbPk2GKpESueSR+DhV/F6RSdYwIDQQEBAoIBAAg3dta6PZbBmNhp2HVcI4jeAnh/zEqVw9THsa14Ax0Jsirjrp+HxXR8qhN1ZSvgLouub/ZCggdw1+p91PXsLCe+yK/9LyVaivgzJ2TuRP3iuY7w7o4BnraRFiNW6IFThWoiwa9s/0sEbq84uzA0yPfWzET9x89m53vpIr0jRqeMfz7qVUq/pU5XZa+EBVjmJk8jVBvGdS0YlFqyZJ6IHHpKdEiZqJ1BHPkxaSNdsnLQhS0q3LrVmB1eD6cB31I6j4WqiXIo+CJ2U1IihpzAZN13wlqASVXmjcthPYU1CJ6k5T9C2ZzPLQxHnrJxn81c+TXyx05IHRYbzb3vpoMWafECgYEA7XKQ4xnDhXPwuQ7adUE6IYAICr0lmK06R30+LOn55GXuw/bJx7A/dorW5AlMRev7xac6jIq0kXB9Y0nbwUVnRivJ2qehZzBuVUmj9u+hqQSyLv0jYrC6fmL5ZPD+FpsdPRWpvBMJl5Mw4AzqSmWOi3gCoTaMPKWpdiOrxpDymtkCgYEAzQXHEC/VuF5yLcCM+rCQcIrTTLEwEfQ+TAQ0kKIQMpX2MCN205Ynw2eQusDajrwxNvl69xg6Aco+VkYg3NI11YjLtHRLGHs4JLHVE1wiU3S4gCAUbMl3uTm4mIzZY4ck7v1BoQJx16+ygObV4/W2YBI3XoQSOykamSSHQBKL/JsCgYEA2+4HoTHV1aAj0WSel4iI7UqHKFs1nYqltl2c30EAgrqfQscs8lafEY9bpu+tw/3lv5c7Nb2rriKBIRvh/cvo8ifQ2UP2zXsgVsLUqf4m9Pn6h6glh3Ul57aIxSQqVInrtQ6BnoALnGdrF7serzYNp8TKusOpdOsEYTZ8/nh3HVECgYEAo8QSrwZWo++lKpCcy/5PUeRCZAdgy2aagGP3jPQ3FgEdZnRdjUNqvbYzMEmuCseeVDhQuSp341gmJQndZCXxZIDhnmIqPgLm5MC737v/m0QnwAhf6EnBfU3y+r+/QbYItXHMg40NXGj2n+pDPdTeebzzR2cdnO4HVf6MnoxyDzMCgYEApNQLQaGuHIrA9X0Y91rRfFAL4J7XQAIsc08LKtyKX1711wtK53eWbp2vTF0OWwIKr2j5aQHrUph77Pde4Sg5t2mQumgT/m/WGk6z07+4I3/ZqqxJmGqspxUBxysAygQRY0jQyApZxu5psO30M4RqHWmdlnfnfHpZETmsiH2QIfk=-----END RSA PRIVATE KEY-----"", 
""publicKeyCertificate"": ""-----BEGIN CERTIFICATE-----MIIGiDXCBOCgAwIBEgIQDZr3BQvqDqr3AFGCF9ABlTANBgkqhkiG9w0BAQsFADBeMQswCQYDVQQGEwJVUzEVMBMGA1UEChQQRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMR0wGwYDVQQDExRHZW9UcnVzdCBSU0EgQ0EgMjAxODAeFw0xOTEwMjEwMDAwMDBaFw0yMTEwMjAxMjAwMDBaMHIxCzAJBgNVBAYTAktSMRQwEgYDVQQIEwtHeWVvbmdnaS1kbzEUMBIGA1UEBxMLU3VvbmduYW0tc2kxFDASBgNVBAoTC05BVkVSIENvcnAuMSEwHwYDVQQDExhrb3Njb21zZWMuZmluLW5jbG91ZC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC+Khnlwjjt1jzIkzi54ax15aHPKSL/7m82HGa55bj4IkzNf4vnKbuHdgs0rCGIm2T77Vx91twm44Zi3NfGf62wrDNjFvwvhwopA/gmOB6C/x+aZExpAEU681PcmGG2GAwLWswsZpJx7Acuj/0o7pAmX0DpZFIZWpWLRzocyvtVhU/8IUpAJGfrAyYhnShSmZTTgC9zLKgNtqCvhpzAOSGzeT58QbZ2AZlcOIfMUiZ9NC8i2jxtzpSbqfxigrZiM7z8NFvBlGZTyA0Z86voL6LzwTBTgzKbtLQUvIaA3Org3CgovQpRqvlv3pQRzUE9s+TYYqkRK55JH4OFX8XpJF1jAgMBAAGjggMsMIIDKDAfBgNVHSMEGDAWgBSQWP+wnHWoUVR3se3zn1MWOJ5sxTAdBgNVHQ4EFgQUv0PgIrSH01tzeRg+qXE2fQXKfGMwIwYRDV0RBBwwGoIYa29zY29tc2VjLmZpbi1uY2xvdWQuY29tMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwPgYDVR0fBDcwNTAzoDGgL4YtaHR0cDovL2NkcC5nZW90cnVzdC5jb20vR2VvVHJ1c3RSU0FDQTIwMTguY3JsMEwGA1UdIARFMEMwNwYJYIZIAYb9bAEBMCowKAYIKwYBBQUHAgEWHGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQICMHUGCCsGAQUFBwEBBGkwZzAmBggrBgEFBQcwAYYaaHR0cDovL3N0YXR1cy5nZW90cnVzdC5jb20wPQYIKwYBBQUHMAKGMWh0dHA6Ly9jYWNlcnRzLmdlb3RydXN0LmNvbS9HZW9UcnVzdFJTQUNBMjAxOC5jcnQwCQYDVR0TBAIwADCCAYAGCisGAQQB1nkCBAIEggFwBIIBbAFqAHYApLkJkLQYWBSHuxOizGdwCjw1mAT5G9+443fNDsgN3BAAAAFt7QSAjwAABAMARzBFAiEAsrtCX/W5mIL2RmPyi/J0t7r4FtZ8GjdkEqPfR8R3HfsCIASdmn/Pyh0YdUoErgLYvA0fKTRWnqOrMBxxAYJNu/CaAHcARJRlLrDuzq/EQAfYqP4owNrmgr7YyzG1P9MzlrW2gagAAAFt8QSAhQAABAMASDBGAiEA35rObBTcUlVh0XmEhkQPQMSDDxYrDdrVtQq5uVlEJogCIQCery1e8cDlimVik6bYrt4In5P/O0OKPcI6IPC9UvlSLgB3ALvZ37wfinG1k5Qjl6qSe0c4V5UKq1LoGpCWZDaOHtGFAAABbe0EgJAAAAQDAEgwRgIhAPXF4hYQev2k6X20t/y++0t1+tWj7FfIj7rbP0PmEOv7AiEA1Ds3EluKokoHZKUMMvlysi0dI0rECevEEflMDoTUEPYwDQYJKoZIhvcNAQELBQADggEBAEFHWKCqC7U3jyQ4q/asJ/T+CBKEVP91+KL/Tq8IbQEhELcMS+Q7ru8L7wxnHycW42syBj/CAdMJuOtbOldcxBgkekdxFRE8K+V4q33vm3D969cHpPDmNz4YLH+/LDAiTOVAFuviastrAxdqsprr/f4+/+ZE9QZ13NeZxup6NBlHB/6FPkTn3OBkatFPwaoSPnJ8XcDuxtQSHSz2aJc72N/932VaN8rrkHmM5SXMJ8bNEgBBCj6N/v0jY/suTz7C5b5VgyuKNgoHvzAb8/oLMDsgoARdIAjypOG/JoPhZqOOdhiVxYWBot/fAC8S1IXRp/dDuD2mS/lbLFksULw48Cg=-----END CERTIFICATE-----""
}"

Response example

Response header

connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Mon, 13 Jul 2020 14:14:26 GMT 
referrer-policy: unsafe-url 
server: nginx 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 32cj46him8dhg30oj668rjedb3

Response body

{
  "returnCode": "0",
  "returnMessage": "Success",
  "totalRows": 1,
  "sslCertificateList": [
    {
      "certificateNo": 1,
      "certificateName": "myCertificate-01",
      "memberNo": "1",
      "dnInfo": "CN=exmaple.net",
      "domainAddress": "exmaple.net",
      "subDomainAddress": "www.exmaple.net",
      "regDate": "2020-05-30 14:40:48",
      "issueDate": null,
      "validStartDate": "2019-07-10 09:00:00",
      "validEndDate": "2021-07-10 08:59:59",
      "disuseDate": null,
      "disuseMsg": null,
      "requestId": null,
      "statusCode": "1",
      "statusName": "Normal",
      "externalYn": "Y",
      "domainCode": "PUB",
      "caInfo": "XYZ RSA Domain Validation Secure Server CA",
      "certSerialNumber": "bfc9f64ca4532d9897d542c72988d61f",
      "certPublicKeyInfo": "Sun RSA public key, 2048 bits",
      "certSignAlgorithmName": "SHA256withRSA",
      "usedInstanceNoList": null
    }
  ]
}

Error codes

Errors that may occur while using this action are listed below. For information on common errors, refer to NAVER Cloud Platform.

HTTP response code	errorCode	Message	Description
200	1002	Unable to load certificate. Expecting PEM format file.	certificateChain OR privateKey OR publicKeyCertificate is not valid PEM format string.
200	26034	The certificate is invalid.	Certificate is not valid.
200	26040	Public key in certificate does not match with private key.	An error occurred while verify private key consistency.
400	2000	CertificateName is invalid. certificateName can only contain 3-20 English alphabet, numbers, and "-" and must start with an alphabetic character.	Certificate name is not valid.
400	2100	CertificateName is missing; PrivateKey is missing; PublicKeyCertificate is missing; CertificateChain is missing.	Can not found certificateChain OR certificateName OR privateKey OR publicKeyCertificate.

Was this article helpful?

What's Next

deleteCertificate

Table of contents

Overview
Request
Response
Examples
Error codes