| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="acmedns_v1.html">ACME DNS API</a> . <a href="acmedns_v1.acmeChallengeSets.html">acmeChallengeSets</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(rootDomain, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets the ACME challenge set for a given domain name. Domain names must be provided in Punycode.</p> | |
| <p class="toc_element"> | |
| <code><a href="#rotateChallenges">rotateChallenges(rootDomain, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">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.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(rootDomain, x__xgafv=None)</code> | |
| <pre>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. For example, this would be "google.com" for any FQDN under "google.com". That includes challenges for "subdomain.google.com". 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. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="rotateChallenges">rotateChallenges(rootDomain, body=None, x__xgafv=None)</code> | |
| <pre>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. For example, this would be "google.com" for any FQDN under "google.com". That includes challenges for "subdomain.google.com". 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. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| </body></html> |