getCertificateList

Article Summary

Share feedback

Thanks for sharing your feedback!

Overview

Search SSL certificates and view the detail informations of them.

Request

Method	Request URI
GET	`https://certificatemanager.apigw.ntruss.com/api/v1/certificates`

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`

Request parameters

Parameter	Required	Type	Description
certificateName	No	String	Searching by certificate name `Default : Searching all certificates`
certificateNo	No	Integer	Searching by certificate number `Default : Searching all certificates`
instanceNo	No	Integer	Searching by instance number `Default : Searching all certificates`

Response

Response body

Field	Type	Description
returnCode	String	Response code
returnMessage	String	Response message
totalRows	Integer	Number of objects in sslCertificateList
sslCertificateList[]	String	Certificate searching result If one or more objects are existed: `List is not empty`

Examples

Request example

curl -X GET "https://certificatemanager.apigw.ntruss.com/api/v1/certificates" 
-H "accept: application/json" 
-H "x-ncp-iam-access-key: 72A565A16F1827A27DD5" 
-H "x-ncp-apigw-timestamp: 1594646226859" 
-H "x-ncp-apigw-signature-v2: y0hqZ1RyFtJjTq7ZLcu6ds1d8HyzoTgT1XoPjkyoYA8=" 
-H "cache-control: no-cache" 
-H "pragma: no-cache"

Response example

Response header

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

Response body

{
  "returnCode": "0",
  "returnMessage": "Success",
  "totalRows": 3,
  "sslCertificateList": [
    {
      "certificateNo": 3,
      "certificateName": "myCertificate-03",
      "memberNo": "1",
      "dnInfo": "CN=www.example.com, O=NAVER Cloud Corp., L=Bundang-gu, S=Seongnam-si, C=KR",
      "domainAddress": "www.example.com",
      "subDomainAddress": "",
      "regDate": "2020-07-13 13:52:36",
      "issueDate": null,
      "validStartDate": "2019-10-21 09:00:00",
      "validEndDate": "2021-10-20 21:00:00",
      "disuseDate": null,
      "disuseMsg": null,
      "requestId": null,
      "statusCode": "1",
      "statusName": "Normal",
      "externalYn": "N",
      "domainCode": "PUB",
      "caInfo": "NAVER Secure Certification Authority 1",
      "certSerialNumber": "e9af6050aea0e2af700519217c00f95",
      "certPublicKeyInfo": "Sun RSA public key, 2048 bits",
      "certSignAlgorithmName": "SHA256withRSA",
      "usedInstanceNoList": null
    },
    {
      "certificateNo": 2,
      "certificateName": "myCertificate-02",
      "memberNo": "1",
      "dnInfo": "CN=mail.example.com",
      "domainAddress": "mail.example.com",
      "subDomainAddress": "mail2.example.com",
      "regDate": "2020-07-13 13:36:57",
      "issueDate": null,
      "validStartDate": "2019-10-21 09:00:00",
      "validEndDate": "2021-10-20 21:00:00",
      "disuseDate": null,
      "disuseMsg": null,
      "requestId": null,
      "statusCode": "1",
      "statusName": "Normal",
      "externalYn": "Y",
      "domainCode": "PUB",
      "caInfo": "ABC RSA CA 2018",
      "certSerialNumber": "d9af6050bea0e2af700518217c00695",
      "certPublicKeyInfo": "Sun RSA public key, 2048 bits",
      "certSignAlgorithmName": "SHA256withRSA",
      "usedInstanceNoList": null
    },
    {
      "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	2200	No certificate was found.	Not found any certificates.

Was this article helpful?

What's Next

createExternalCertificate

Table of contents

Overview
Request
Response
Examples
Error codes