List DNSSEC keys

This endpoint allows you to list the DNSSEC keys published for all your domains.
By default, only keys published to the registry are returned, but you can filter by status to list previous keys that are no longer published.
Many results can be returned, so filters are available and a pagination system is provided.

Endpoint

GET /dns/v3/dnssec/keys

Parameters

Name	Location	Required	Type	Default value	Description
limit	URL	No	Integer	100	Number of keys to return (max 500)
offset	URL	No	Integer	0	Offset used
sort	URL	No	String	domain	Field used to sort keys. Allowed values : domain, published_at, unpublished_at
domain	URL	No	String		Search by domain name. Wildcard compatible
status	URL	No	String	[PENDING_PUBLISH, PUBLISHED, PENDING_UNPUBLISH]	Search by key status. Allowed values : PENDING_PUBLISH: The key has been added and is awaiting publication to the registry. PUBLISHED: The key is published to the registry. PENDING_UNPUBLISH: The key has been removed and is awaiting unpublication to the registry. UNPUBLISHED: The key is unpublished to the registry.
keytag	URL	No	Integer		Search by keytag.
algorithm	URL	No	Integer		Search by algorithm. Allowed values : 8: RSASHA256 10: RSASHA512 13: ECDSA256 14: ECDSA384
digest_type	URL	No	Integer		Search by digest type. Allowed values : 2: SHA256 4: SHA384
customer_id	URL	No	Integer		Search by customer ID.
include_subsidiaries	URL	No	Boolean	true	Include subsidiaries in the search.

Response

A DnssecKeySearchResults object.

Example Request

GET /dns/v3/dnssec/keys?limit=2&offset=2&status=PUBLISHED

Example Response

{
    "message": "OK",
    "data": {
        "total": 100,
        "limit": 2,
        "offset": 2,
        "sort": "domain",
        "domain": null,
        "status": "PUBLISHED",
        "customer_id": 123,
        "keytag": null,
        "digest_type": null,
        "algorithm": null,
        "include_subsidiaries": true,
        "results": [
            {
                "id": "55555",
                "domain": "example.com",
                "keytag": 1234,
                "flags": 257,
                "algorithm": 8,
                "digest": "DCE839052E82C23842CB373A580DFDC52A325CEFAC72E7F8107E2B6BD7306C38",
                "digest_type": 2,
                "public_key": "MIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgHTc6SB7q2UnFI3Rtz0c+eYHv/eJmasjVvCG/6hWwMDPifd0bfuZtSouaA2aA7m+Ctk1OYFlPc3caGedPRy6f1JyCI/YWL+Oos35LSMnJlW977bynC/ecHFKARR8XUbi0p6Nu7L77jXd3Q0f+ZsK4UeEjjM6rqUHgAXjpJo7yVuvAgMBAAE=",
                "status": "PUBLISHED",
                "created_at": "2021-01-05T16:48:27.000000Z",
                "published_at": "2021-01-05T17:18:35.000000Z",
                "deleted_at": null,
                "unpublished_at": null
            },
            {
                "id": "55555",
                "domain": "example.net",
                "keytag": 4567,
                "flags": 257,
                "algorithm": 8,
                "digest": "DCE839052E82C23842CB373A580DFDC52A325CEFAC72E7F8107E2B6BD7306C38",
                "digest_type": 2,
                "public_key": "MIGeMA0GCSqGSIb3DQEBAQUAA4DCBiAKBgHTc6SB7q2UnFI3Rtz0c+eYHv/eJmasjVvCG/6hWwMDPifd0bfuZtSouaA2aA7m+Ctk1OYFlPc3caGedPRy6f1JyCI/YWL+Oos35LSMnJlW977bynC/ecHFKARR8XUbi0p6Nu7L77jXd3Q0f+ZsK4UeEjjM6rqUHgAXjpJo7yVuvAgMBAAE=",
                "status": "PUBLISHED",
                "created_at": "2021-01-12:02:03.000000Z",
                "published_at": "2021-01-05T12:04:57.000000Z",
                "deleted_at": null,
                "unpublished_at": null
            }
        ]
    }
}