Request

Endpoint: !WebHostReport

https://secure.trust-provider.com/products/!WebHostReport

Use the POST method for this endpoint.

Submit parameters in the x-www-form-urlencoded format.

Request parameters

The following table displays the required, optional, and conditional parameters.

Parameter Requirement Type Max.Length Description

loginName

conditional

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

required

string

128 chars

Your account password.

This value is case sensitive.

notBefore

optional

integer

The timestamp indicates when the certificate was issued.

It is expressed as a UNIX time value.

Orders placed before this time will be ignored.

notAfter

optional

integer

The timestamp indicates when the certificate was issued.

It is expressed as a UNIX time value.

The orders placed after this time will be ignored.

firstResultNo

optional

integer

Specifies the index of the first result to return.

lastResultNo

optional

integer

Specifies the index of the last result to return.

organizationName

optional

string

64 string

Specifies the organization name.

The allowed characters:

  • _ — Single-character wildcard.

  • % — Multi-character wildcard.

fqdn

optional

string

255 chars

Specifies the fully qualified domain name (FQDN).

_ and % wildcards are allowed.

orderNumber

optional

string

32767 chars

Specifies one or more comma-separated generated order numbers.

If required, orderNumber can be specified multiple times. All of the comma-separated orderNumber lists will be concatenated together.

_ and % wildcards are not allowed.

foreignOrderNumber

optional

string

32767 chars

Specifies one or more comma-separated foreign order numbers.

_ and % wildcards are not allowed.

certificateID

optional

string

32767 chars

Specifies one or more comma-separated generated certificate IDs.

_ and % wildcards are not allowed.

showStatusDetails

optional

char

1 char

Specifies whether to include status details in the report.

The allowed values are:

  • Y — Include the status details in the response.

  • N — Do not include the status details in the response.

certificateStatusCode

optional

integer

Specifies one or more comma-separated certificate code statuses.

The allowed values are:

  • 1 — awaitingvalidation

  • 3 — caacheckfailed

  • 5 — failed

  • 6 — issued

  • 7 — rejected

  • 8 — revoked

  • 9 — issuedawaitingcollection

  • 12 — awaitingbrandvalidation

  • 13 — awaitingrequest

  • 14 — replaced

certificateStatusDesc

optional

string

64 chars

Specifies one or more comma-separated certificate statuses.

The allowed values are:

  • awaitingvalidation

  • failed

  • issued

  • rejected

  • revoked

  • issuedawaitingcollection

  • awaitingbrandvalidation

  • awaitingrequest

  • replaced

  • caacheckfailed

showAdditionalDomains

optional

char

1 char

Specifies whether to include additional domains in the report.

The allowed values are:

  • Y — Include additional domain for single certificate, and show domain names for MDC.

  • N — Do not include additional domains.

showSignatureAlgorithm

optional

char

1 char

Specifies whether to include the signature algorithm in the report.

The allowed values are:

  • Y — Include SignatureAlgorithm in the response.

  • N — Do not include SignatureAlgorithm in the response.

If omitted, the value defaults to N.

expireNotBefore

optional

integer

The timestamp indicates when the certificate expires.

It is expressed as a UNIX time value.

The orders placed before this time will be ignored.

expireNotAfter

optional

integer

The timestamp indicates when the certificate expires.

It is expressed as a UNIX time value.

The orders placed after this time will be ignored.

showOldItems

optional

char

1 char

Specifies whether to include old items in the report.

The allowed values are:

  • Y — Include the old items (for example, replaced SSL certificates) in the response.

  • N — Do not include the old items in the response.

If omitted, the value defaults to N.

showCertificateID

optional

char

1 char

Specifies whether to include the certificate ID in the report.

The allowed values are:

  • Y — Include the certificateID of the certificates in the response.

  • N — Do not include the certificateID of the certificates in the response

If omitted, the value defaults to N.

showExtStatus

optional

char

1 char

Specifies whether to include the extended status in the report.

The allowed values are:

  • Y — Return the extended validation status.

  • N — Do not return the extended validation status.

If omitted, the value defaults to N.

showStatusesOnly

optional

char

1 char

Specifies whether to include only the statuses in the report.

The allowed values are:

  • Y — Include the following parameter types in the response:

    • errorCode

    • noOfResults

    • X_orderNumber

    • X_foreignOrderNumber

    • X_orderStatus

    • X_validationStatus

    • X_Y_certificateID

    • X_Y_status

    • X_Y_lastStatusChange

  • N — Do not include the preceding parameter types in the response.

If omitted, the value defaults to N.

showCost

optional

char

1 char

Specifies whether to include the cost in the response.

The allowed values are:

  • Y — Include the X_cost in the response.

  • N — Do not include the X_cost in the response.

If omitted, the value defaults to N.

showAssociatedOrders

optional

char

1 char

Specifies whether to include associated replacement orders in the report.

The allowed values are:

  • Y — Include the details of associated replacement orders (MDC replacements) in the response.

  • N — Return only the requested order details.

If omitted, the value defaults to N.

firstResultNo and lastResultNo are provided to enable pagination of the report without having to retrieve the entire result set of reports.

Only one variable of organizationName, fqdn or orderNumber can be specified.

Sample request

curl --location 'https://secure.trust-provider.com/products/!WebHostReport' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password

Response

The request is successful when the server returns a response with the status code equals 0.

Any status code less than 0 indicates an error condition.

The list of codes and their descriptions can be found in Error codes.

The MIME type will be application/x-www-form-urlencoded, because the format of the response will be the same URL-encoded format as the request (for example, name1=value1&name2=value2).

Response parameters

The following table displays the various parameters that can appear in the response.

Parameter Type Description

errorCode

integer

A numeric code that identifies the type of error.

For more information, see Error codes.

errorMessage

string

A description of the error.

noOfResults

integer

Total number of results.

X_orderNumber

string

The generated order number.

X_foreignOrderNumber

string

An external order number for integration with partner systems.

X_orderStatus

string

Description of the current status of the order (for example, 'Pending', 'Processed')

X_cost

float (15,4)

Order total amount in the account currency.

Shown without the currency symbol.

X_dateTime

integer

Date/time when the order was placed.

It is expressed as a UNIX time value.

X_organizationName

string

The name of the company.

X_organizationalUnitName

string

The department within the company.

X_postOfficeBox

string

The company’s post office box.

X_streetAddress1

string

The company’s street address.

X_streetAddress2

string

The second part of the company’s street address (if necessary).

X_streetAddress3

string

The third part of the company’s street address (if necessary).

X_localityName

string

The city in which the company resides.

X_stateOrProvinceName

string

The company’s state or province.

X_postalCode

string

The company’s postal code.

X_countryName

string

The company’s full country name (for example, United States).

X_validationStatus

string

The validation status.

Available if showExtStatus=Y.

X_Y_type

integer

The type of the certificate.

The possible values are:

  • 43 — Trial SSL certificate.

  • 44 — Intranet SSL certificate.

  • 24 — InstantSSL certificate.

  • 34 — InstantSSL Pro certificate.

  • 7 — PremiumSSL certificate.

  • 35 — PremiumSSL Wildcard certificate.

  • 36 — TrustLogo.

  • 37 — Card Payment TrustLogo.

X_Y_domain

string

The fully qualified domain name for SSL certificates.

The domain insurance covering breaches for TrustLogos (for example, .sectigo.net/) .

X_Y_additionalDomain

string

The additional domain for single certificates if input showAdditionalDomains=Y.

X_Y_mdcDomainNames

string

The domain names for MDC if the input showAdditionalDomains=Y.

X_Y_status

string

The current status of the certificate.

X_Y_lastStatusChange

integer

The date or time when the status of this certificate last changed.

It is expressed as a UNIX time value.

X_Y_notBefore

integer

The date or time when the certificate became valid.

It is expressed as a UNIX time value.

X_Y_notAfter

integer

The date or time when the certificate stops being valid.

It is expressed as a UNIX time value.

X_Y_certificateDuration

integer

The certificate duration.

Displayed in days.

X_Y_serialNumber

string

The certificate serial number.

Available for SSL certificates only.

X_Y_signatureAlgorithm

string

The key algorithm.

Available for SSL certificates only.

X_Y_keySize

string

The key size (for example, 1024-bit).

Available for SSL certificates only.

X_Y_webserverSoftware

string

The webserver software specified in AutoApplySSL that is used with the certificate.

Available for SSL certificates only.

X_Y_certificateID

integer

The internal certificate ID for this element of the order where relevant.

Available if showCertificateID=Y.

X_Y_csrStatus

integer

The CSR status of certificate.

Available if showStatusDetails=Y.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_dcvStatus

integer

DCV Status of certificate

Available if showStatusDetails=Y.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_ovCallBackStatus

integer

The OV callback status of the account.

Available if showStatusDetails=Y.

The possible values are:

  • -1 — Not applicable.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_organizationValidationStatus

integer

A string describing the current status of account validation (OV).

Available if showStatusDetails=Y.

The possible values are:

  • -1 — Not applicable.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_freeDVUPStatus

integer

The status of Free DV Upgrade.

Available if showStatusDetails=Y.

The possible values are:

  • -1 — Not applicable.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

The X in most of the preceding parameters is a placeholder for an integer.

This integer is the 'result number' within the entire result set.

Each 'result number' corresponds to a different order within the entire result set.

The Y is a placeholder for an integer.

It is the 'item number' within an order.

The first item in each order has Y=1.

For example, if firstResultNo=5 and lastResultNo=7 in the request. The following parameter names for X_orderNumber are displayed in the response:

  • 5_orderNumber

  • 6_orderNumber

  • 7_orderNumber

The results are sorted in reverse date order (the 'date' being when the order was placed, not the 'valid from' date of any certificate within the order).

Sample success response

The success response with code 0 and getting details for the all webhost’s orders in a time period (notBefore / notAfter).

errorCode=0&noOfResults=1&1_orderNumber=xxxxxxxx&1_orderStatus=Processed&1_foreignOrderNumber=xxxxxx&1_cost=x&x_x_status=Valid&1_1_lastStatusChange=xxxxxxxxxx&1_1_certificateID=xxxxxxxxxx

Sample error response

errorCode=-16&errorMessage=Incorrect+login+details%2C+account+is+locked%2C+password+has+expired+or+your+source+IP+is+blocked.

Error codes

The following table outlines error responses returned by the WebHostReport API endpoint. Each error response consists of an errorCode and an errorMessage indicating why the request failed.

Error Code Error Message Description

-1

Request was not made over HTTPS!

The request must use HTTPS protocol.

-2

'xxxx' is an unrecognized argument!

The provided argument is not recognized.

-3

The 'xxxx' argument is missing!

The required argument is missing from the request.

-4

The value of the 'xxxx' argument is invalid!

The argument value does not meet validation requirements.

-14

An unknown error occurred!

An unknown error occurred.

-16

Permission denied!

The user doesn’t have the permission to perform the specified action.

-17

Request used GET rather than POST!

The request method should be POST.

-42

Call limit reached! Please try again later

Indicates that the maximum number of API calls has been reached.