Get trust anchor list

Prev Next

Available in Classic and VPC

Get the list of trust anchors.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/trust-anchors

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
searchColumn String Optional Search column
  • name | trustAnchorNrn
    • name: trust anchor name
    • trustAnchorNrn: NAVER Cloud Platform resource identification value for trust anchor
searchWord String Optional Search keyword

Request example

The request example is as follows:

curl --location --request GET 'https://externalaccess.apigw.ntruss.com/api/v1/trust-anchors?searchColumn=name&searchWord=ta000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
trustAnchorId String - Trust anchor ID
trustAnchorNrn String - NAVER Cloud Platform resource identification value for trust anchor
name String - Trust anchor name
description String - Trust anchor description
enabled Boolean - Status
  • true | false
    • true: enabled
    • false: disabled
createTime String - Creation date and time
  • ISO 8601 format
updateTime String - Last modification date and time
  • ISO 8601 format
source Object - CA information
source.sourceType String - CA type
  • NCP_PCA | CERTIFICATE_BUNDLE
    • NCP_PCA: when using NAVER Cloud Platform's Private CA
    • CERTIFICATE_BUNDLE: when using a CA created externally by the user
source.sourceData Object - CA target information
source.sourceData.caId Integer - NAVER Cloud Platform Private CA's ID
  • sourceType: if NCP_PCA
source.sourceData.x509CertificateData String - CA certificate data created by the user externally
  • PEM format
  • sourceType: if CERTIFICATE_BUNDLE

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account response status codes.

Response example

The response example is as follows:

[
    {
        "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
        "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
        "name": "ta000",
        "description": "test",
        "enabled": false,
        "createTime": "2024-12-13T13:16:50.331+09:00",
        "updateTime": "2024-12-13T13:16:50.331+09:00",
        "source": {
            "sourceType": "NCP_PCA",
            "sourceData": {
                "caId": *****
            }
        }
    },
    {
        "trustAnchorId": "b271f5b5-****-****-****-bda95123e58e",
        "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/b271f5b5-****-****-****-bda95123e58e",
        "name": "ta001",
        "description": "test",
        "enabled": false,
        "createTime": "2024-11-13T13:16:50.331+09:00",
        "updateTime": "2024-11-13T13:16:50.331+09:00",
        "source": {
            "sourceType": "CERTIFICATE_BUNDLE",
            "sourceData": {
                "x509CertificateData": "-----BEGIN CERTIFICATE-----\n{CA}\n-----END CERTIFICATE-----"
            }
        }
    }
]