Help Center> SSL Certificate Manager> API Reference> Historical APIs> Adding an Additional Domain Name
View PDF

Adding an Additional Domain Name

Function

This API is used to add an additional domain name. If you have a multi-domain SSL certificate and available quota for additional domain names, you can add additional domain names for the certificate after it is issued.

URI

  • URI format

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

  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

    cert_id

    Yes

    String

    Certificate ID.

Request

Request parameters

Parameter

Mandatory

Type

Description

ori_sans

Yes

String

Additional domain name bound to a multi-domain certificate.

If multiple domain names are displayed, the domain names are separated by semicolons (;).

Example: example.domain.com;example.domain1.com

add_sans

No

String

Additional domain name to be added for a multi-domain certificate.

If multiple domain names need to be entered, separate the domain names by semicolons (;).

Example: example.domain2.com;example.domain3.com

email

No

String

Email of a contact.

Response

Response parameters

Parameter

Mandatory

Type

Description

request_info

Yes

String

Request result.

Example

The following describes how to add an additional domain name example.domain.com.

  • Example request 
    {
    "ori_sans": "abc.com;xyz.com",
    "add_sans": "example.domain.com",
    "email": "example@xx.com"
}
  • Example response 
    { 
    "request info":"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 code, see Error Code

Parent topic: Historical APIs