Skip to main content

CAA Record Parser analyzes DNS CAA records that specify which Certificate Authorities are authorized to issue certificates for a domain.

Project description

CAA Record Parser API

CAA Record Parser analyzes DNS CAA records that specify which Certificate Authorities are authorized to issue certificates for a domain.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the CAA Record Parser API


Installation

Using pip:

pip install apiverve-caarecordparser

Using pip3:

pip3 install apiverve-caarecordparser

Configuration

Before using the caaparser API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_caarecordparser.apiClient import CaaparserAPIClient

# Initialize the client with your APIVerve API key
api = CaaparserAPIClient("[YOUR_API_KEY]")

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The CAA Record Parser API documentation is found here: https://docs.apiverve.com/ref/caaparser. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_caarecordparser.apiClient import CaaparserAPIClient

# Initialize the client with your APIVerve API key
api = CaaparserAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "raw_record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"",
    "parsed": {
      "domain": "example.com",
      "ttl": 3600,
      "class": "IN",
      "flags": 0,
      "tag": "issue",
      "value": "letsencrypt.org"
    },
    "ca_info": {
      "name": "Let's Encrypt",
      "type": "Free",
      "wildcard_support": true
    },
    "interpretation": {
      "meaning": "Only letsencrypt.org is authorized to issue certificates",
      "restriction": "Restricted to specific CA",
      "critical": false,
      "critical_explanation": "Non-critical - CA may proceed if not understood"
    },
    "tag_description": "Authorizes a CA to issue certificates (any type)",
    "is_valid": true
  }
}

Error Handling

The API client provides comprehensive error handling through the CaaparserAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_caarecordparser.apiClient import CaaparserAPIClient, CaaparserAPIClientError

api = CaaparserAPIClient("[YOUR_API_KEY]")

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except CaaparserAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_caarecordparser.apiClient import CaaparserAPIClient, CaaparserAPIClientError

api = CaaparserAPIClient("[YOUR_API_KEY]")

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except CaaparserAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_caarecordparser.apiClient import CaaparserAPIClient, CaaparserAPIClientError

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

# Using context manager ensures proper cleanup
with CaaparserAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except CaaparserAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_caarecordparser.apiClient import CaaparserAPIClient

# Enable debug mode
api = CaaparserAPIClient("[YOUR_API_KEY]", debug=True)

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_caarecordparser.apiClient import CaaparserAPIClient

api = CaaparserAPIClient("[YOUR_API_KEY]")

query = { "record": "example.com. 3600 IN CAA 0 issue \"letsencrypt.org\"" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_caarecordparser-1.1.14.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_caarecordparser-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_caarecordparser-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_caarecordparser-1.1.14.tar.gz
Algorithm Hash digest
SHA256 9c350cd6790cdede4ad5d8e54467159920fc74c5762f32d6be4170e0a206a87b
MD5 5997fb72b83cc8f406346d783163bd63
BLAKE2b-256 f5217c2036622df036d090f1da77bb6c0e35e79a03d12903ea493f13ead2337e

See more details on using hashes here.

File details

Details for the file apiverve_caarecordparser-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_caarecordparser-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 687730b96894cb5e0fe1c3042098e999045b626d5df31eed8678c7a15b72bce4
MD5 25f92e1eb1408a76310063734bc56d9a
BLAKE2b-256 6e651911c6f86ca839ec875c7d149fa3371330b1f06bac087691a0cfc749ce9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page