Updated on 2022-08-09 GMT+08:00

Revoking a Certificate

Function

This API is used to revoke a certificate.

URI

  • URI format

    POST /v2/{project_id}/scm/cert/{cert_id}/revoke

  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

    cert_id

    Yes

    String

    Certificate ID.

Request

Request parameters

Parameter

Mandatory

Type

Description

reason

Yes

String

Reason for revoking a certificate.

The value is a string of 0 to 63 characters.

Response

Response parameters

Parameter

Mandatory

Type

Description

message

Yes

String

Revocation request result.

Examples

The following uses the certificate revocation reason "certificate information filled incorrectly" as an example.

  • Example request
    {
        "reason": "certificate information filled incorrectly",
    }
  • Example response
    { 
        "message":"success"
    }

    or

    { 
       "error_code": "SCM.XXXX",  
       "error_msg": "XXXX"   
     }

Status Codes

Table 1 lists the normal status code returned by the API.
Table 1 Status code

Status Code

Status

Description

200

OK

Request processed successfully.

For details about error codes, see Error Codes