Help Center> SSL Certificate Manager> API Reference> API Description> Querying the Certificate List
View PDF

Querying the Certificate List

Function

This API is used to query the certificate list by certificate name or bound domain name.

URI

GET /v3/scm/certificates

Table 1 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of certificate records displayed on each page. The values can be：

  • 10: 10 certificate records can be displayed on each page.

  • 20: 20 certificate records can be displayed on each page.

  • 50: 50 certificate records can be displayed on each page.

Minimum: 10

Maximum: 50

Default: 10

offset

No

Integer

Offset. The value ranges from 1 to 30.

Minimum: 0

Maximum: 30

Default: 0

sort_dir

No

String

Sorting method. Sorting is performed based on the sorting parameter sort_key. The value can be:

  • ASC: Ascending order

  • DESC: descending order.

Default: DESC

Minimum: 0

Maximum: 32

sort_key

No

String

Parameter by which the certificates are sorted out. The value can be:

  • certExpiredTime: certificate expiration time.

  • certStatus: certificate status.

  • certUpdateTime: certificate update time.

Default: certUpdateTime

Minimum: 0

Maximum: 64

status

No

String

Certificate status. The value can be:

  • ALL: All certificate statuses.

  • PAID: The certificate has been paid and needs to be applied for from the CA.

  • ISSUED: The certificate has been issued.

  • CHECKING: The certificate application is being reviewed.

  • CANCELCHECKING: The certificate application cancellation is being reviewed.

  • UNPASSED: The certificate application fails.

  • EXPIRED: The certificate has expired.

  • REVOKING: The certificate revocation application is being reviewed.

  • REVOKED: The certificate has been revoked.

  • UPLOAD: The certificate is being hosted.

  • CHECKING_ORG: the organization verification is to be completed.

  • ISSUING: The certificate is to be issued.

  • SUPPLEMENTCHECKING: Additional domain names to be added for a multi-domain certificate are being reviewed.

Default: ALL

Minimum: 0

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum: 32

Maximum: 2097152

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

certificates

Array of CertificateDetail objects

For details, see data structure description of the CertificateDetail field.

total_count

Integer

Number of certificates.

Minimum: 0

Maximum: 10000
Table 4 CertificateDetail

Parameter

Type

Description

id

String

Certificate ID.

Minimum: 16

Maximum: 16

name

String

Certificate name.

Maximum: 255

Minimum: 1

domain

String

Domain name bound to a certificate.

Minimum: 1

Maximum: 255

type

String

Certificate type. The value can be: DV_SSL_CERT, DV_SSL_CERT_BASIC, EV_SSL_CERT, EV_SSL_CERT_PRO, OV_SSL_CERT, or OV_SSL_CERT_PRO

Minimum: 1

Maximum: 128

brand

String

Certificate authority. The value can be GLOBALSIGN, SYMANTEC, GEOTRUST or CFCA.

Minimum: 1

Maximum: 255

expire_time

String

Certificate expiration time.

Minimum: 1

Maximum: 32

domain_type

String

Domain type. The value can be:

  • SINGLE_DOMAIN: single domain names

  • WILDCARD: wildcard domains

  • MULTI_DOMAIN: multiple domain names

Minimum: 1

Maximum: 128

validity_period

Integer

Certificate validity period, in months.

Minimum: 12

Maximum: 12

status

String

Certificate status. The value can be:

  • PAID: The certificate has been paid, and needs to be applied for from the CA.

  • ISSUED: The certificate has been issued.

  • CHECKING: The certificate application is being reviewed.

  • CANCELCHECKING: The certificate application cancellation is being reviewed.

  • UNPASSED: The certificate application fails.

  • EXPIRED: The certificate has expired. - REVOKING: The certificate revocation application is being reviewed.

  • CANCLEREVOKING: The cancellation on certificate revocation is being reviewed.

  • REVOKED: The certificate has been revoked.

  • UPLOAD: The certificate is being hosted.

  • SUPPLEMENTCHECKING: Additional domain names to be added for a multi-domain certificate are being reviewed.

  • CANCELSUPPLEMENTING: The cancellation on additional domain names to be added is being reviewed.

Minimum: 0

Maximum: 64

domain_count

Integer

Number of domain names can be bound to a certificate.

Minimum: 1

Maximum: 100

wildcard_count

Integer

Number of wildcard domain names can be bound to a certificate.

Minimum: 0

Maximum: 100

description

String

Certificate description

Minimum: 0

Maximum: 255

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Example Requests

None

Example Responses

Status code: 200

Normal return.

{
  "certificates" : [ {
    "id" : "scs1554192131150",
    "name" : "test",
    "domain" : "www.zx.com",
    "type" : "OV_SSL_CERT",
    "brand" : "GEOTRUST",
    "expire_time" : "2021-05-27 16:46:25.0",
    "domain_type" : "MULTI_DOMAIN",
    "validity_period" : 12,
    "status" : "ISSUED",
    "domain_count" : 2,
    "wildcard_count" : 0,
    "description" : null
  } ],
  "total_count" : 1
}

Status code: 401

Authentication failed.

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

Status code: 403

Access denied.

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

Status code: 500

Failed to complete the request because of an internal server error.

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

Status Codes

Status Code

Description

200

Normal return.

401

Authentication failed.

403

Access denied.

404

Access page not found.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: API Description