Deleting a Certificate
Function
This API is used to delete a certificate.
URI
DELETE /v1/{project_id}/waf/certificate/{certificate_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
|
certificate_id |
Yes |
String |
HTTPS certificate ID. It can be obtained by calling the ListCertificates API. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
|
Content-Type |
Yes |
String |
Content type. Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Certificate ID |
|
name |
String |
Certificate name |
|
content |
String |
Certificate file, PEM encoding |
|
key |
String |
Private key of the certificate in PEM format |
|
expire_time |
Long |
Certificate expiration timestamp |
|
exp_status |
Integer |
Certificate status. The options can be: 0: The certificate has not expired. 1: The certificate expired. 2: The certificate is about to expire. |
|
timestamp |
Long |
Certificate upload timestamp |
|
bind_host |
Array of BindHost objects |
Domain name associated with the certificate |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Domain name ID |
|
hostname |
String |
Domain name |
|
waf_type |
String |
Deployment mode of WAF instance that is used for the domain name. The value can be cloud for cloud WAF or premium for dedicated WAF instances. |
|
mode |
String |
This parameter is required only by the dedicated mode. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error message |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error message |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error message |
Example Requests
The following example shows how to delete a certificate in a project. The project ID is specified by project_id, and the certificate ID is specified by certificate_id.
DELETE https://{Endpoint}/v1/{project_id}/waf/certificate/{certificate_id}?enterprise_project_id=0
Example Responses
Status code: 200
OK
{
"id" : "e1d87ba2d88d4ee4a3b0c829e935e5e0",
"name" : "certificatename29556",
"timestamp" : 1650594410630,
"expire_time" : 1596865564000
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Request failed. |
|
401 |
The token does not have required permissions. |
|
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
