Help Center/ Cloud Certificate Manager/ API Reference/ Historical APIs/ SCM APIs/ Querying the Product Type of a Certificate
Updated on 2022-08-09 GMT+08:00
View PDF

Querying the Product Type of a Certificate

Function

This API is used to query information about all products that are being sold on SCM.

URI

  • URI format

    GET /v2/{project_id}/scm/cert/product

  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

Request

Request parameters

None

Response

Response parameters

Parameter

Mandatory

Type

Description

type_list

Yes

Array of type_list objects

Product type list. For details, see Table 1.
Table 1 type_list

Parameter

Mandatory

Type

Description

cert_type

Yes

String

Certificate type.

  • OV_SSL_CERT: Organization Validation (OV) SSL certificate.
  • EV_SSL_CERT: Extended Validation (EV) SSL certificate.

cert_brand

Yes

String

Certificate brand.

GLOBALSIGN: GlobalSign brand.

domain_type

Yes

String

Domain name type.

  • SINGLE_DOMAIN: single-domain name type.
  • MULTI_DOMAIN: multi-domain name type.
  • WILDCARD: wildcard domain name type.

product_id

Yes

String

Product ID.

effective_time

Yes

Integer

Certificate validity period (year).

  • 1: The validity period of the certificate is one year.
  • 2: The validity period of the certificate is two years.

product_name

Yes

String

Product name.

Example

  • Example request

    None

  • Example response
    { 
"type_list": [{
"cert_type": "OV_SSL_CERT",
"cert_brand":"GLOBALSIGN",
"domain_type":"SINGLE_DOMAIN",
"product_id":"00301-106005-0--0",
"effective_time":1,
"product_name ":"globalsign.single.ov.2"
}]
}

    or

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

Status Codes

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

Status Code

Status

Description

200

OK

Request processed successfully.

For details about error code, see Error Codes

Parent topic: SCM APIs