Endpoint: !AutoUpdateDCV

https://secure.trust-provider.com/products/download/!AutoUpdateDCV

The !AutoUpdateDCV API allows you to update the DCV method for an existing certificate order. This endpoint supports both single-domain and multi-domain certificates.

Use the POST method for this endpoint.

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

The following table lists the required and optional parameters.

Parameter Type Requirement Max. Length Description

loginName

string

required

64 chars

Your account username.

This value is case sensitive.

loginPassword

string

required

128 chars

Your account password.

This value is case sensitive.

orderNumber

integer

conditional

The order number for which you want to update the DCV method.

Either orderNumber or baseOrderNumber must be provided.

baseOrderNumber

integer

conditional

A unique identifier for the initial certificate order associated with your account, returned to your account. This parameter is mainly used for certificate replacements. Each replacement order has its own orderNumber, but all related orders share the same baseOrderNumber, which allows them to be linked together.

Either orderNumber or baseOrderNumber must be provided.

domainName

string

required

255 chars

Fully qualified domain name (FQDN) for which the client wants to update the DCV method.

Not required if domainNames is provided.

newMethod

string

required

32 chars

The selected DCV method for the domain name specified in domainName.

The possible values are:

  • EMAIL

  • HTTP_CSR_HASH

  • HTTPS_CSR_HASH

  • CNAME_CSR_HASH

Not required for multi-domain orders if newMethods is provided.

newDCVEmailAddress

string

required

255 chars

DCV email address for a single domain.

The email address must be one of the acceptable addresses for Domain Control Validation (DCV). Use the GetDCVEmailAddressList API to obtain the list of valid DCV email addresses.

Required if newMethod is EMAIL. Not required for multi-domain orders if newDCVEmailAddresses is provided.

domainNames

string

optional

255 chars

(Multi-domain certificates only) Space-separated FQDNs to update the DCV methods.

newMethods

string

optional

32 chars

(Multi-domain certificates only) Comma-separated DCV methods for each domain in domainNames. The number and order of DCV methods must match the FQDNs in domainNames.

The possible values are:

  • EMAIL

  • HTTP_CSR_HASH

  • HTTPS_CSR_HASH

  • CNAME_CSR_HASH

newDCVEmailAddresses

string

optional

255 chars

Space-separated DCV email addresses for each domain in domainNames where the method is EMAIL.

If specified, each address must be valid for DCV for the corresponding domain.

Required only if newMethods includes EMAIL for any FQDN in domainNames.

The number and order of email addresses must match the FQDNs in domainNames where the method is EMAIL.

Sample request

curl --location --request POST 'https://secure.trust-provider.com/products/!AutoUpdateDCV' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=yourLoginName' \
--data-urlencode 'loginPassword=yourPassword' \
--data-urlencode 'orderNumber=yourOrderNumber' \
--data-urlencode 'domainName=yourdomain.com' \
--data-urlencode 'newMethod=HTTP_CSR_HASH' \
--data-urlencode '[email protected]'

Response

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

Any errorCode less than 0 indicates an error condition and the errorMessage provides more details.

The response is formatted in x-www-form-urlencoded format.

If the order number provided has already been issued, the following error message will be returned:

The value of the 'orderNumber' argument is invalid!

Response parameters

The response may contain the following parameters:

Parameter Description

errorCode

A numeric code that identifies the type of error. For more information, see Error codes.

errorMessage

A description of the error.

Sample success response

errorCode=0