Help Center> Web Application Firewall> API Reference> API> Certificate Management> Applying a Certificate to a Domain Name
View PDF

Applying a Certificate to a Domain Name

Function

This API is used to apply a certificate to a domain name.

Debugging

You can use API Explorer to debug this API.

URI

POST /v1/{project_id}/waf/certificate/{certificate_id}/apply-to-hosts

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

certificate_id

Yes

String

Certificate ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

Request Parameters

Table 3 Request header 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
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

cloud_host_ids

No

Array of strings

ID of the HTTPS domain name in cloud mode

premium_host_ids

No

Array of strings

ID of the HTTPS domain name in dedicated mode

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Certificate ID

name

String

Certificate name

timestamp

Long

Time stamp

expire_time

Long

Expiration date

bind_host

Array of CertificateBundingHostBody objects

List of associated domain names
Table 6 CertificateBundingHostBody

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

waf_type

String

WAF mode. The options are cloud and premium.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Example Requests

{ }

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Request failed

401

Insufficient token permissions

500

Internal server error

Error Codes

See Error Codes.

Parent topic: Certificate Management