PUT api/Certificate/{handle}/Validate?user={user}

Method to validate a certificate once the Meta key is placed

Request Information

URI Parameters

Name	Description	Type	Additional information
handle	Object handle	string	Required
user	Owner of object	string	None.

Body Parameters

Optional - object contaning the url list to validate

CertDetails

Name	Description	Type	Additional information
Handle	Certificate handle	string	None.
CommonName	Common name	string	None.
ProductName	Product name	string	None.
AdminContact	Admin contact handle	string	None.
BillingContact	Billing contact handle	string	None.
ValidationMethod	Validation method - set at time of command	string	None.
OrderId	Order id - internal	string	None.
TicketId	Ticket id - internal	decimal number	None.
DnsTxt	DNS validation key in case of Dns validation	string	None.
MetaTag	Meta tag to place in gsdv.txt file in case of Meta validation	string	None.
VerificationUrlList	List of urls that can be verified with meta validation. Return the list of urls you wich to verify when calling the validate method. If left empty when calling the validate method, the system will attempt to verify all urls available	Collection of string	None.
WellknownUrlList	Location(s) of the gsdv.txt files. These files need to made available before calling the validate method.	Collection of string	None.
VerificationFQDNList	List of domains to verify when using Dns validation	Collection of string	None.
ApproverMailList	List of approver email addresses to choose from	Collection of string	None.
PossiblePhishingDetected	True when possible phishing detected	boolean	None.
RegDate	Registration date	date	None.
ExpDate	Expiry date	date	None.
Status	Object status	string	None.
AutoRenew	Has auto renew	boolean	None.
TicketState	Current ticket state	string	None.
Error		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Handle": "sample string 1",
  "CommonName": "sample string 2",
  "ProductName": "sample string 3",
  "AdminContact": "sample string 4",
  "BillingContact": "sample string 5",
  "ValidationMethod": "sample string 6",
  "OrderId": "sample string 7",
  "TicketId": 8.0,
  "DnsTxt": "sample string 9",
  "MetaTag": "sample string 10",
  "VerificationUrlList": [
    "sample string 1",
    "sample string 2"
  ],
  "WellknownUrlList": [
    "sample string 1",
    "sample string 2"
  ],
  "VerificationFQDNList": [
    "sample string 1",
    "sample string 2"
  ],
  "ApproverMailList": [
    "sample string 1",
    "sample string 2"
  ],
  "PossiblePhishingDetected": true,
  "RegDate": "2024-07-10T01:37:00.6071864+02:00",
  "ExpDate": "2024-07-10T01:37:00.6071864+02:00",
  "Status": "sample string 13",
  "AutoRenew": true,
  "TicketState": "sample string 14",
  "Error": "sample string 15"
}

application/xml, text/xml

Sample:

<CertDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Certificates">
  <AdminContact>sample string 4</AdminContact>
  <ApproverMailList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ApproverMailList>
  <AutoRenew>true</AutoRenew>
  <BillingContact>sample string 5</BillingContact>
  <CommonName>sample string 2</CommonName>
  <DnsTxt>sample string 9</DnsTxt>
  <Error>sample string 15</Error>
  <ExpDate>2024-07-10T01:37:00.6071864+02:00</ExpDate>
  <Handle>sample string 1</Handle>
  <MetaTag>sample string 10</MetaTag>
  <OrderId>sample string 7</OrderId>
  <PossiblePhishingDetected>true</PossiblePhishingDetected>
  <ProductName>sample string 3</ProductName>
  <RegDate>2024-07-10T01:37:00.6071864+02:00</RegDate>
  <Status>sample string 13</Status>
  <TicketId>8</TicketId>
  <TicketState>sample string 14</TicketState>
  <ValidationMethod>sample string 6</ValidationMethod>
  <VerificationFQDNList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </VerificationFQDNList>
  <VerificationUrlList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </VerificationUrlList>
  <WellknownUrlList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WellknownUrlList>
</CertDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A certificate details object on success
Collection of errors on failure
Return codes
200 - ok
300 - ambiguous
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
550 - parameter value policy error
727 - This SSL certificate is not issued yet
741 - VerificationUrlList not available
742 - Unable to validate certificate

CertDetails

Name	Description	Type	Additional information
Handle	Certificate handle	string	None.
CommonName	Common name	string	None.
ProductName	Product name	string	None.
AdminContact	Admin contact handle	string	None.
BillingContact	Billing contact handle	string	None.
ValidationMethod	Validation method - set at time of command	string	None.
OrderId	Order id - internal	string	None.
TicketId	Ticket id - internal	decimal number	None.
DnsTxt	DNS validation key in case of Dns validation	string	None.
MetaTag	Meta tag to place in gsdv.txt file in case of Meta validation	string	None.
VerificationUrlList	List of urls that can be verified with meta validation. Return the list of urls you wich to verify when calling the validate method. If left empty when calling the validate method, the system will attempt to verify all urls available	Collection of string	None.
WellknownUrlList	Location(s) of the gsdv.txt files. These files need to made available before calling the validate method.	Collection of string	None.
VerificationFQDNList	List of domains to verify when using Dns validation	Collection of string	None.
ApproverMailList	List of approver email addresses to choose from	Collection of string	None.
PossiblePhishingDetected	True when possible phishing detected	boolean	None.
RegDate	Registration date	date	None.
ExpDate	Expiry date	date	None.
Status	Object status	string	None.
AutoRenew	Has auto renew	boolean	None.
TicketState	Current ticket state	string	None.
Error		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Handle": "sample string 1",
  "CommonName": "sample string 2",
  "ProductName": "sample string 3",
  "AdminContact": "sample string 4",
  "BillingContact": "sample string 5",
  "ValidationMethod": "sample string 6",
  "OrderId": "sample string 7",
  "TicketId": 8.0,
  "DnsTxt": "sample string 9",
  "MetaTag": "sample string 10",
  "VerificationUrlList": [
    "sample string 1",
    "sample string 2"
  ],
  "WellknownUrlList": [
    "sample string 1",
    "sample string 2"
  ],
  "VerificationFQDNList": [
    "sample string 1",
    "sample string 2"
  ],
  "ApproverMailList": [
    "sample string 1",
    "sample string 2"
  ],
  "PossiblePhishingDetected": true,
  "RegDate": "2024-07-10T01:37:00.6071864+02:00",
  "ExpDate": "2024-07-10T01:37:00.6071864+02:00",
  "Status": "sample string 13",
  "AutoRenew": true,
  "TicketState": "sample string 14",
  "Error": "sample string 15"
}

application/xml, text/xml

Sample:

<CertDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Certificates">
  <AdminContact>sample string 4</AdminContact>
  <ApproverMailList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ApproverMailList>
  <AutoRenew>true</AutoRenew>
  <BillingContact>sample string 5</BillingContact>
  <CommonName>sample string 2</CommonName>
  <DnsTxt>sample string 9</DnsTxt>
  <Error>sample string 15</Error>
  <ExpDate>2024-07-10T01:37:00.6071864+02:00</ExpDate>
  <Handle>sample string 1</Handle>
  <MetaTag>sample string 10</MetaTag>
  <OrderId>sample string 7</OrderId>
  <PossiblePhishingDetected>true</PossiblePhishingDetected>
  <ProductName>sample string 3</ProductName>
  <RegDate>2024-07-10T01:37:00.6071864+02:00</RegDate>
  <Status>sample string 13</Status>
  <TicketId>8</TicketId>
  <TicketState>sample string 14</TicketState>
  <ValidationMethod>sample string 6</ValidationMethod>
  <VerificationFQDNList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </VerificationFQDNList>
  <VerificationUrlList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </VerificationUrlList>
  <WellknownUrlList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WellknownUrlList>
</CertDetails>