ACME DNS API . acmeChallengeSets

Instance Methods

close()

Close httplib2 connections.

get(rootDomain, x__xgafv=None)

Gets the ACME challenge set for a given domain name. Domain names must be provided in Punycode.

rotateChallenges(rootDomain, body=None, x__xgafv=None)

Rotate the ACME challenges for a given domain name. By default, removes any challenges that are older than 30 days. Domain names must be provided in Punycode.

Method Details

close()
Close httplib2 connections.
get(rootDomain, x__xgafv=None)
Gets the ACME challenge set for a given domain name. Domain names must be provided in Punycode.

Args:
  rootDomain: string, Required. SLD + TLD domain name to list challenges. This MAY be Unicode or Punycode. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The up-to-date ACME challenge set on a domain for an RPC. This contains all of the ACME TXT records that exist on the domain.
  "record": [ # The ACME challenges on the requested domain represented as individual TXT records.
    { # The TXT record message that represents an ACME DNS-01 challenge.
      "digest": "A String", # Holds the ACME challenge data put in the TXT record. This will be checked to be a valid TXT record data entry.
      "fqdn": "A String", # The domain/subdomain for the record. In a request, this MAY be Unicode or Punycode. In a response, this will be in Unicode. The fqdn MUST contain the root_domain field on the request.
      "updateTime": "A String", # Output only. The time when this record was last updated. This will be in UTC time.
    },
  ],
}
rotateChallenges(rootDomain, body=None, x__xgafv=None)
Rotate the ACME challenges for a given domain name. By default, removes any challenges that are older than 30 days. Domain names must be provided in Punycode.

Args:
  rootDomain: string, Required. SLD + TLD domain name to update records for. This MAY be Unicode or Punycode. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for the RotateChallenges RPC. Requires an access token, a root domain, and either records_to_add or records_to_remove to be populated. Records may be set for multiple subdomains at once to support SAN requests for multiple subdomains in a single domain. By default, ACME TXT record challenges that are older than 30 days will be removed. Set `keep_expired_records` to false if this behavior is undesired. There is a record maximum of 100 records per domain including expired records. Any request sent that would exceed this maximum will result in a FAILED_PRECONDITION error. NEXT ID: 6
  "accessToken": "A String", # Required. ACME DNS access token. This is a base64 token secret that is procured from the Google Domains website. It authorizes ACME TXT record updates for a domain.
  "keepExpiredRecords": True or False, # Keep records older than 30 days that were used for previous requests.
  "recordsToAdd": [ # ACME TXT record challenges to add. Supports multiple challenges on the same FQDN.
    { # The TXT record message that represents an ACME DNS-01 challenge.
      "digest": "A String", # Holds the ACME challenge data put in the TXT record. This will be checked to be a valid TXT record data entry.
      "fqdn": "A String", # The domain/subdomain for the record. In a request, this MAY be Unicode or Punycode. In a response, this will be in Unicode. The fqdn MUST contain the root_domain field on the request.
      "updateTime": "A String", # Output only. The time when this record was last updated. This will be in UTC time.
    },
  ],
  "recordsToRemove": [ # ACME TXT record challenges to remove.
    { # The TXT record message that represents an ACME DNS-01 challenge.
      "digest": "A String", # Holds the ACME challenge data put in the TXT record. This will be checked to be a valid TXT record data entry.
      "fqdn": "A String", # The domain/subdomain for the record. In a request, this MAY be Unicode or Punycode. In a response, this will be in Unicode. The fqdn MUST contain the root_domain field on the request.
      "updateTime": "A String", # Output only. The time when this record was last updated. This will be in UTC time.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The up-to-date ACME challenge set on a domain for an RPC. This contains all of the ACME TXT records that exist on the domain.
  "record": [ # The ACME challenges on the requested domain represented as individual TXT records.
    { # The TXT record message that represents an ACME DNS-01 challenge.
      "digest": "A String", # Holds the ACME challenge data put in the TXT record. This will be checked to be a valid TXT record data entry.
      "fqdn": "A String", # The domain/subdomain for the record. In a request, this MAY be Unicode or Punycode. In a response, this will be in Unicode. The fqdn MUST contain the root_domain field on the request.
      "updateTime": "A String", # Output only. The time when this record was last updated. This will be in UTC time.
    },
  ],
}