Update CA
    • PDF

    Update CA

    • PDF

    Article summary

    Available in Classic and VPC

    Change the CA status.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    PUT/ca/{caTag}

    Request headers

    For headers common to all Private CA APIs, see Common Private CA headers.

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    caTagStringRequiredCA tag value

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    statusStringRequiredCA status
    • ACTIVE | DEACTIVATED | DESTROYING
      • ACTIVE: enabled
      • DEACTIVATED: disabled
      • DESTROYING: scheduled for deletion
    Caution

    If you change the status to DESTROYING, the CA and its subordinate CAs are automatically deleted after a 72-hour deletion waiting period. This process does not take into account the operational status or expiration of any certificates issued by the CA. The private key of a deleted CA is permanently deleted and can't be recovered, so use caution when deciding to delete a CA. Also, a deleted CA is no longer trusted, and any certificates issued by that CA can't be used for authentication purposes.

    Request example

    The following is a sample request.

    curl --location --request PUT 'https://pca.apigw.ntruss.com/api/v1/ca/********-********' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json' \
    --data '{
        "status": "DESTROYING"
    }'
    

    Response

    The following describes the response format.

    Response body

    The following describes the response body.

    FieldTypeRequiredDescription
    codeString-Response code
    msgString-Response message
    dataObject-Response result
    data.caInfoObject-CA information
    data.caInfo.signingCountNumber-No. of certificates signed by CA
    data.caInfo.caTypeString-CA type
    • PRIVATE_ROOT | PRIVATE_SUB
    data.caInfo.caIdNumber-CA identifier
    data.caInfo.statusUpdateDateString-Latest status change date and time (timestamp)
    data.destroyDateString-Deletion date and time (timestamp)
    data.caInfo.aliasString-CA name
    data.caInfo.memoString-CA memo
    data.caInfo.urlInfoObject-URL information
    data.caInfo.urlInfo.ocspArray-Online Certificate Status Protocol (OCSP) URL
    data.caInfo.urlInfo.crlArray-Certificate revocation list (CRL) URL
    data.caInfo.urlInfo.caArray-CA URL
    data.caTagString-CA tag value
    data.rgstDateNumber-Registration date and time (timestamp)
    data.statusString-CA status
    • ACTIVE | DEACTIVATED | DESTROYING
      • ACTIVE: enabled
      • DEACTIVATED: disabled
      • DESTROYING: scheduled for deletion

    Response status codes

    For response status codes common to all Private CA APIs, see Private CA response status codes.

    Response example

    The following is a sample example.

    {
        "code": "SUCCESS",
        "msg": "Success",
        "data": {
            "signingCount": 0,
            "caType": "PRIVATE_ROOT",
            "caId": 17***,
            "statusUpdateDate": 1721106009601,
            "destroyDate": 1721368800000,
            "alias": "CA002",
            "memo": "",
            "urlInfo": {
                "ocsp": [],
                "crl": [
                    "https://pca.apigw.ntruss.com/ext/********-********/crl"
                ],
                "ca": [
                    "https://pca.apigw.ntruss.com/ext/********-********/ca"
                ]
            },
            "caTag": "********-********",
            "rgstDate": 1721105599000,
            "status": "DESTROYING"
        }
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.