tencent cloud

All product documents
SSL Certificates
DocumentationSSL CertificatesAPI DocumentationCertificate APIsDeleteCertificate
DeleteCertificate
Download PDF
Last updated: 2025-02-27 16:22:04
DeleteCertificate
Last updated: 2025-02-27 16:22:04
Download PDF

1. API Description

Domain name for API request: ssl.intl.tencentcloudapi.com.

This API is used to delete a certificate.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteCertificate.
Version Yes String Common Params. The value used for this API: 2019-12-05.
Region No String Common Params. This parameter is not required for this API.
CertificateId Yes String Certificate ID
IsCheckResource No Boolean When deleting, check whether the certificate is associated with cloud resources. By default, no check is performed. if you choose to check (the authorization service role SSL_QCSLinkedRoleInReplaceLoadCertificate is required), the deletion will become asynchronous, and the API will return an asynchronous task id. you need to use the DescribeDeleteCertificatesTaskResult API to check whether the deletion is successful.

3. Output Parameters

Parameter Name Type Description
DeleteResult Boolean Deletion result
TaskId String Asynchronous deletion task id.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 This API Is Used To Delete Certificates

Input Example

POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCertificate
<Common request parameters>

{
    "CertificateId": "hhe**jjsj",
    "IsCheckResource": false
}

Output Example

{
    "Response": {
        "DeleteResult": true,
        "RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
    }
}

Example2 Asynchronous Deletion

Input Example

POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCertificate
<Common request parameters>

{
    "CertificateId": "tey**hdh",
    "IsCheckResource": true
}

Output Example

{
    "Response": {
        "DeleteResult": false,
        "TaskId": "1251261",
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.AuthError You do not have permission to perform this operation.
FailedOperation.BoundResources Cannot be deleted when there are unbound cloud resources.
FailedOperation.CancelOrderFailed Failed to cancel the order.
FailedOperation.CannotBeDeletedIssued Failed to delete the certificate because it has been issued.
FailedOperation.CannotBeDeletedWithinHour Free certificates cannot be deleted within 1 hour after being applied for.
FailedOperation.CannotGetOrder Failed to get order information. Try again later.
FailedOperation.CertificateNotFound The certificate does not exist.
FailedOperation.DeleteFailedTimeNotUp Cannot be deleted when the free cert application time has not exceeded 1 hour.
FailedOperation.DeleteResourceFailed The certificate is associated with a Tencent Cloud resource and cannot be deleted.
FailedOperation.InvalidCertificateStatusCode The certificate status is incorrect.
FailedOperation.InvalidParam Incorrect parameters.
FailedOperation.NetworkError The CA system is busy. Try again later.
FailedOperation.NoProjectPermission You do not have the permission to operate on this project.
FailedOperation.NoRealNameAuth You have not completed the identity verification.
FailedOperation.OrderAlreadyReplaced This order has already been replaced.
FailedOperation.RenewNotIssued Cannot perform deletion when the renewed cert has not been issued.
FailedOperation.RoleNotFoundAuthorization The role does not exist. Please authorize the role first.
InternalError Internal error.
LimitExceeded.RateLimitExceeded The API rate limit is reached.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon