Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Certificate Management/ Querying the List of Certificates
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Querying the List of Certificates

Function

This API is used to query the list of certificates.

URI

GET /v1/{project_id}/waf/certificate

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Page number

Default: 1

pagesize

No

Integer

Number of records on each page.

Default: 10

name

No

String

Certificate name

host

No

Boolean

Whether to obtain the Domain name the certificate is applied to

Default: false

exp_status

No

Integer

Certificate status. The options are 0, 1, and 2. 0: The certificate does not expire. 1: The certificate has expired. 2: The certificate is about to expire.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

items

Array of CertificateBody objects

Certificate list

total

Integer

Number of certificates
Table 5 CertificateBody

Parameter

Type

Description

id

String

Certificate ID

name

String

Certificate name

content

String

Certificate file, in PEM format

key

String

Certificate private key (in PEM format)

expire_time

Long

Certificate expiration Time stamp

exp_status

Integer

Certificate status. The options are 0, 1, and 2. 0: The certificate does not expire. 1: The certificate has expired. 2: The certificate is about to expire.

timestamp

Long

Time the certificate was uploaded

bind_host

Array of BindHost objects

Domain name the certificate is applied to
Table 6 BindHost

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

waf_type

String

WAF edition for the domain name. The options are cloud and premium.

mode

String

(Dedicated mode only) Special domain name mode

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

None

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