Management > Certificate Manager > API v1.3 Guide

Certificate Manager provides APIs for retrieving certificate lists and downloading certificates. After registering certificates and certificate files in the console, clients can access and utilize the data through the API.

CertificateManager API Common Information

API Endpoint

https://certmanager.api.nhncloudservice.com

API Request HTTP Header

X-NHN-AUTHORIZATION: Bearer {issued token}

Authentication and Authorization

CertificateManager uses User Access Key tokens for authentication and authorization when making API calls. The User Access Key token is a temporary, Bearer-type access token issued from a User Access Key. For more information on issuing and using User Access Key tokens, please refer to the User Access Key Token.

CertificateManager API uses role-based access (RBAC).
Users must have either the CertificateManager ADMIN role or CertificateManager VIEWER role to use the API.

Provided APIs

Method URI Description
GET /certmanager/v1.3/appkeys/{appKey}/certificates Retrieve the certificate list.
GET /certmanager/v1.3/appkeys/{appKey}/certificates/{certificateName}/files Download the registered certificate file.
API Request Path Variables
Value Type Description
appKey String AppKey of the NHN Cloud project where the data is stored
certificateName String Data (certificate) name to use
API Response's Common Data Header
{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {

    }
}
Value Type Description
resultCode Number API call result code
resultMessage String API call result message
isSuccessful Boolean API call success status

Retrieve a Certificate List

You can use it to retrieve the certificate lists registered in the Certificate Manager.

Request

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.3/appkeys/{appKey}/certificates?pageSize={pageSize}&pageNum={pageNum}&all={all}&status={status}
Value Type Description Input allowed
pageSize Number Page size 10 (default)
pageNum Number Page number 1 (default)
all Boolean Whether to retrieve all true, false (default)
status String Certificate status ALL, EXPIRED, UNEXPIRED (default)

※ The values for all, status are case-insensitive.

Response

[Response Header]

Content-Type:application/json

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "totalCount": 1,
        "totalPage": 1,
        "currentPage": 1,
        "pageSize": 10,
        "data": [
            {
                "certificateName": "nhncloudservice.com",
                "authority": "NHN",
                "domains": [
                  "nhncloudservice.com",
                  "*.nhncloudservice.com"
                ],
                "signatureAlgorithm": "SHA256withRSA",
                "fileCreationDate": "2025-03-02",
                "expirationDate": "2026-03-25"
            }
        ]
    }
}
Value Type Description
totalCount Number Total number of certificates
totalPage Number Total number of pages
currentPage Number Current page
pageSize Number Page size
certificateName String Certificate name
authority String Certificate authority
signatureAlgorithm String Signature method
fileCreationDate String Certificate file creation date
expirationDate String Certificate file expiration date

Download a Certificate File

You can use it to download certificate files registered in the Certificate Manager.

Request

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.3/appkeys/{appKey}/certificates/{certificateName}/files

Success Response

[Response Header]

Content-Disposition:attachment; filename="{filename}"
Content-Type:application/octet-stream

[Response Body]

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
...
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----

Failure Response

[Response Header]

Content-Type:application/json

[Response Body]

{
    "header": {
        "resultCode": 52000,
        "resultMessage": "Certificate name does not exist.",
        "isSuccessful": false
    },
    "body": {}
}

Using the Command Line Interface (CLI)

You can request the certificate file download API using the curl command.

#Write to file
curl 'https://certmanager.api.nhncloudservice.com/certmanager/v1.3/appkeys/{appKey}/certificates/{certificateName}/files' \
    -H "X-NHN-AUTHORIZATION: Bearer {issued token}" > cert.pem

#Specify a filename
curl -o cert.pem 'https://certmanager.api.nhncloudservice.com/certmanager/v1.3/appkeys/{appKey}/certificates/{certificateName}/files' \
    -H "X-NHN-AUTHORIZATION: Bearer {issued token}"

#Maintain the uploaded filename
curl -OJ 'https://certmanager.api.nhncloudservice.com/certmanager/v1.3/appkeys/{appKey}/certificates/{certificateName}/files' \
    -H "X-NHN-AUTHORIZATION: Bearer {issued token}"

Response Code

isSuccessful resultCode resultMessage Description
true 0 SUCCESS Success
false 52000 Certificate name does not exist. The requested certificate name does not exist.
false 52001 Certificate file does not exist. The requested certificate file does not exist.
false 52002 There are more than one certificate file. The requested certificate file has more than one certificate file.
false 52003 The certificate file is not a PEM file. The requested certificate file is not a PEM format file.
false 52004 The certificate name in the file is different from the requested certificate name. The requested certificate name and the name registered in the certificate file are different.
false 52005 Certificate file has expired. The requested certificate file has expired.
false 52006 The certificate has an invalid certificate authority name. The certificate authority information in the requested certificate file is invalid.
false 52007 The requested certificate file should be one. Only one certificate file can be uploaded at a time.
false 52008 The maximum permitted size is {} bytes. However, the requested {} bytes. The maximum file size that can be uploaded is 512 KB.
Table of Contents
TOP