DNSSEC Delegation Signer Webservice API
GKG.NET offers a RESTful webservice for managing your DNSSEC Delegation Signer records. All request and response bodies are JSON documents.
URI and JSON templates in this document are represented as follows:
- Values in %% are variables
- The value yourdomain.tld should be replaced with your own domain name.
- All other symbols are literals
All errors use JSON to supplement their status codes:
{"details":"%message%"}
Authentication
Basic Authentication for this webservice is deprecated!
NOTE: Previous versions of this webservice used HTTP Basic authentication. Although Basic authentication is still supported, users are strongly encouraged to migrate to token based authentication.
All requests are authenticated using a token style API key. Each API method has its own set of access requirements that must be present in the API key.
You can generate API keys for your account at:
https://www.gkg.net/protected/contact/api-keys
Note that API keys are linked to your specific account. Your API key will not work with another users domain names.
API Keys must be sent with your requests in the Authorization header as follows:
Authorization: Bearer eyJ...
Failure to provide an API key in the Authorization header will result in
a 401 Unauthorized response from the server. If the API key
is not linked with a user associated with the domain you are attempting
to query or modify, then a 403 Forbidden response will be
returned. If the API key does not contain the required permissions for
the current operation, a 403 Forbidden response is returned.
For example, sending a POST request to
https://www.gkg.net/ws/domain/yourdomain.com/ds with an API
key that does not have the write:ds permission
will result in a 403 Forbidden response.
API Methods
The following API methods are available:
- Create a Delegation Signer Record
- Get a Delegation Signer Record
- List Delegation Signer Records
- Delete Delegation Signer Records
Create a Delegation Signer Record
In order to create a new DS record in your domain account, you need to use the
POST method on the domain.
Get A Delegation Signer Record
In order to retrieve a specific DS record, you need to use the GET
method on the DS record's url.
List Delegation Signer Records
In order to retrieve all DS records for a domain, you need to use the
GET method on the domain's URL.
Delete A Delegation Signer Record
In order to delete a DS record from a domain, you need to use the
DELETE method on the DS record's URL.
