DnsKeys

For a list of methods for this resource, see the end of this page.

Resource representations

A DNSSEC key pair.

{
  "kind": "dns#dnsKey",
  "id": string,
  "algorithm": string,
  "keyLength": unsigned integer,
  "publicKey": string,
  "creationTime": string,
  "isActive": boolean,
  "type": string,
  "keyTag": integer,
  "digests": [
    {
      "type": string,
      "digest": string
    }
  ],
  "description": string
}

Property name	Value	Description
`algorithm`	`string`	String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. Acceptable values are: "`ecdsap256sha256`" "`ecdsap384sha384`" "`rsasha1`" "`rsasha256`" "`rsasha512`"
`creationTime`	`string`	The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
`description`	`string`	A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
`digests[]`	`list`	Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
`digests[].digest`	`string`	The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
`digests[].type`	`string`	Specifies the algorithm used to calculate this digest. Acceptable values are: "`sha1`" "`sha256`" "`sha384`"
`id`	`string`	Unique identifier for the resource; defined by the server (output only).
`isActive`	`boolean`	Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
`keyLength`	`unsigned integer`	Length of the key in bits. Specified at creation time then immutable.
`keyTag`	`integer`	The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#dnsKey"`.
`publicKey`	`string`	Base64 encoded public half of this key. Output only.
`type`	`string`	One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. Acceptable values are: "`keySigning`" "`zoneSigning`"

Methods

get: Fetch the representation of an existing DnsKey.
list: Enumerate DnsKeys to a ResourceRecordSet collection.