| GET | /api/public/domains/validate | Validates that the domain's SMTP server is capable of StartTLS and messages could be sent securely using basic messaging. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Domain | query | String | Yes | Domain to check for TLS support. |
| Refetch | path | String | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Domain | form | string | No | |
| IsEncrypted | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/public/domains/validate HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"domain": "String",
"isEncrypted": false,
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}