TLS Checker API - Ruby Gem

TLS Check inspects which TLS/SSL protocol versions a server supports. It probes TLS 1.0 through 1.3, reports which are negotiable, and derives a security verdict — the highest supported version, whether deprecated protocols are still exposed, and a composite risk score.

Installation

Add this line to your application's Gemfile:

gem 'apiverve_tlscheck'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install apiverve_tlscheck

Getting Started

Get your API key at APIVerve

Basic Usage

require 'apiverve_tlscheck'

# Initialize the client
client = APIVerve::Tlscheck::Client.new(api_key: "YOUR_API_KEY")

# Make a request
response = client.execute({
  domain: "amazon.com",
  port: 443
})

# Print the response
puts response

Error Handling

begin
  response = client.execute({ domain: "amazon.com", port: 443 })
  puts response["data"]
rescue APIVerve::Tlscheck::ValidationError => e
  puts "Validation error: #{e.errors.join(', ')}"
rescue APIVerve::Tlscheck::APIError => e
  puts "API error: #{e.message}"
  puts "Status code: #{e.status_code}"
end

Debug Mode

# Enable debug logging
client = APIVerve::Tlscheck::Client.new(
  api_key: "YOUR_API_KEY",
  debug: true
)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "domain": "amazon.com",
    "tlsVersions": {
      "TLSv1": false,
      "TLSv1.1": false,
      "TLSv1.2": true,
      "TLSv1.3": true
    },
    "highestVersion": "TLSv1.3",
    "hasDeprecatedTLS": false,
    "isSecure": true,
    "riskScore": 0,
    "riskLevel": "low"
  }
}

Documentation

For more information, visit the API Documentation.

Support

License

This gem is available under the MIT License.