Management > Certificate Manager > API v1.1 Guide

Certificate Manager provides APIs for viewing and downloading a list of certificates. Clients can register certificates and certificate files in the console and then use the data through APIs.

Common Certificate Manager API Information

API EndPoint

https://certmanager.api.nhncloudservice.com
API Request HTTP Header

Required fields are added to the HTTP header in v1.1.

X-TC-AUTHENTICATION-ID: {User Access Key ID}
X-TC-AUTHENTICATION-SECRET: {Secret Access Key}

Authentication and Authorization

Certificate Manager uses User Access Key authentication for authentication and authorization when calling APIs. User Access Key is an authentication key issued based on an NHN Cloud account or IAM account, and is used together with a Secret Access Key as an authentication method for API requests. For more information on using User Access Key, refer to User Access Key Authentication.

Certificate Manager API uses role-based access control (RBAC).
Users must have the Certificate Manager ADMIN Role or Certificate Manager VIEWER Role to use the API.

Supported API Types

Method URI Description
GET /certmanager/v1.1/appkeys/{appKey}/certificates Retrieves a list of certificates.
GET /certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files Downloads a registered certificate file.
Path Variables of API Request
Value Type Description
appKey Token ID Appkey of the NHN Cloud project where the data in need is stored
certificateName Token ID Name of the data (certificate) you want to use
[Common Data Header of API Response]
{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        ...
    }
}
Value Type Description
resultCode Number Result code value of API call
resultMessage Token ID Result message of API call
isSuccessful Boolean Whether API call is successful or not

List Certificates

Used to query the list of certificates registered with Certificate Manager.

Request

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates?pageSize={pageSize}&pageNum={pageNum}&all={all}&status={status}
Value Type Description Available input
pageSize Number Page size 10(default)
pageNum Number Page number 1(default)
all Boolean Retrieve all or not true, false(default)
String Token ID Certificate status ALL, EXPIRED, UNEXPIRED(default)

※ The values for all and 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": "test.nhn.com",
                "authority": "NHN",
                "signatureAlgorithm": "SHA256withRSA",
                "fileCreationDate": "2020-03-02",
                "expirationDate": "2021-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 Token ID Certificate name
authority Token ID Certificate Authority
signatureAlgorithm Token ID Signature method
fileCreationDate Token ID Certificate file creation date
expirationDate Token ID Certificate file expiration date

Download Certificate File

Downloads certificates registered in Certificate Manager.

Request

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.1/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": {}
}

For Command Line Interface (CLI)

Download Certificate File API can be requested by using the curl command. 

#Write to File
curl -H 'X-TC-AUTHENTICATION-ID: {User Access Key ID}' \
    -H 'X-TC-AUTHENTICATION-SECRET: {Secret Access Key}' \
    'https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files' > cert.pem

#Specify File Name
curl -o cert.pem \
    -H 'X-TC-AUTHENTICATION-ID: {User Access Key ID}' \
    -H 'X-TC-AUTHENTICATION-SECRET: {Secret Access Key}' \
    'https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files'

#Maintain Uploaded File Name
curl -OJ \
    -H 'X-TC-AUTHENTICATION-ID: {User Access Key ID}' \
    -H 'X-TC-AUTHENTICATION-SECRET: {Secret Access Key}' \
    'https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files'

Response Codes

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