docs
api
SSL Certificate Management(USSL)
GetDVAuthInfo

Obtain DNS or FILE verification information - GetDVAuthInfo

Overview

Obtain DNS or FILE verification information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetDVAuthInfo.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
CertificateIDintCertificate Number of PurchaseYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
AuthMethodstringVerification Method DNS|FILEYes
Authsarray[AuthSet]Content to be verifiedYes

Data Model

AuthSet

Field NameTypeDescription InformationRequired
AuthKeystringThe key corresponding to the DNS's CNAME, the file name corresponding to FILE.Yes
AuthValuestringThe value corresponding to DNS's CNAME, the content of the file corresponding to FILE.Yes
DomainstringDomain NameYes
AuthPathstringThe file path corresponding to FILEYes
AuthRecordstringRecord value corresponding to DNSYes
AuthTypestringYes
AuthFilestringYes
AuthMethodstringYes

Example

Request Example

https://api.surfercloud.com/?Action=GetDVAuthInfo
&CertificateID=1

Response Example

{
  "Action": "GetDVAuthInfoResponse",
  "AuthMethod": "DNS",
  "Auths": [
    {
      "authKey": "s5iljpx7j6dvmup5i4nyxwb4z3rfvnwj.bestenover.com",
      "authValue": "s20170106185910.bestenover.com",
      "domain": "www.bestenover.com"
    }
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved