Retrieving IPSECKEY Records using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
See RFC 4025 for more information about the IPSECKEY record.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/IPSECKEYRecord/ GET — Retrieves one or all existing IPSECKEY Records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one IPSECKEY record — https://api.dynect.net/REST/IPSECKEYRecord/<zone>/<fqdn>/<record_id>/
Get IPSECKEY records — https://api.dynect.net/REST/IPSECKEYRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one IPSECKEY record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record to replace.
- string
precedence — Indicates priority among multiple IPSECKEYS. Lower numbers are higher priority.
- string
gatetype — Gateway type.
0 = no gateway used
1 = IPv4 address
2 = IPv6 address
3 = gateway hostname (mygateway.example.com).
- string
algorithm — Public key’s cryptographic algorithm and format.
0 = no key present
1 = DSA key present
2 = RSA key present
- string
gateway — Gateway used to create IPsec tunnel. Based on Gateway type.
gateway type = 0 then gateway must contain a single period (.).
gateway type = 1 then type in IPv4 address
gateway type = 2 then type in IPv6 address
gateway type = 3 then type in the hostname with trailing period (mygateway.example.com.)
- string
public_key — Base64 encoding of the public key. Whitespace is allowed.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get IPSECKEY records: array — Individual IPSECKEY record resources. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneIPSECKEYRecord — Retrieves a single existing IPSECKEY Record on the zone/node indicated.
GetIPSECKEYRecords — Retrieves all the existing IPSECKEY Records on the zone/node indicated. |
Arguments:
GetOneIPSECKEYRecord — Click for More Info
- string
fqdn — Required. Name of node where the records exist.
- string
record_id — ID of the record to retrieve.
- hash
rdata — Required. RData defining the record.
- string
precedence — Required. Indicates priority among multiple IPSECKEYS. Lower numbers are higher priority.
- string
gatetype — Required. Gateway type.
0 = no gateway used
1 = IPv4 address
2 = IPv6 address
3 = gateway hostname (mygateway.example.com).
- string
algorithm — Required. Public key’s cryptographic algorithm and format.
0 = no key present
1 = DSA key present
2 = RSA key present
- string
gateway — Required. Gateway used to create IPsec tunnel. Based on Gateway type.
gateway type = 0 then gateway must contain a single period (.).
gateway type = 1 then type in IPv4 address
gateway type = 2 then type in IPv6 address
gateway type = 3 then type in the hostname with trailing period (mygateway.example.com.)
- string
public_key — Required. Base64 encoding of the public key. Whitespace is allowed.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the records exist.
GetIPSECKEYRecords — Click for More Info
string fqdn — Required. Name of node where the records exist.
string token — Required. The session identifier.
string zone — Required. Name of zone where the records exist.
|
Response:
GetOneIPSECKEYRecord — Click for More Info
- hash
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
precedence — Indicates priority among multiple IPSECKEYS. Lower numbers are higher priority.
- string
gatetype — Gateway type.
0 = no gateway used
1 = IPv4 address
2 = IPv6 address
3 = gateway hostname (mygateway.example.com).
- string
algorithm — Public key’s cryptographic algorithm and format.
0 = no key present
1 = DSA key present
2 = RSA key present
- string
gateway — Gateway used to create IPsec tunnel. Based on Gateway type.
gateway type = 0 then gateway must contain a single period (.).
gateway type = 1 then type in IPv4 address
gateway type = 2 then type in IPv6 address
gateway type = 3 then type in the hostname with trailing period (mygateway.example.com.)
- string
public_key — Base64 encoding of the public key. Whitespace is allowed.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
GetIPSECKEYRecords — Click for More Info
- array
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
precedence — Indicates priority among multiple IPSECKEYS. Lower numbers are higher priority.
- string
gatetype — Gateway type.
0 = no gateway used
1 = IPv4 address
2 = IPv6 address
3 = gateway hostname (mygateway.example.com).
- string
algorithm — Public key’s cryptographic algorithm and format.
0 = no key present
1 = DSA key present
2 = RSA key present
- string
gateway — Gateway used to create IPsec tunnel. Based on Gateway type.
gateway type = 0 then gateway must contain a single period (.).
gateway type = 1 then type in IPv4 address
gateway type = 2 then type in IPv6 address
gateway type = 3 then type in the hostname with trailing period (mygateway.example.com.)
- string
public_key — Base64 encoding of the public key. Whitespace is allowed.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
|
Example Request (GetOneIPSECKEYRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'precedence' => 10,
'gatetype' => 3,
'algorithm' => 2
'gateway' => 'ipsec.example.com',
'public_key' => 'AQPWA4BRyjB3eqYNy/oykeGcSXjl+HQK9CciAxJfMcS1vEuwz9c+QG7sEJnQuH5B9i5o/ja+DVitY3jpXNa12mEn',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetIPSECKEYRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base