blob: 1b402e9eaa131860c2bcb642f3e81c6d9221abb0 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="domainsrdap_v1.html">Domains RDAP API</a> . <a href="domainsrdap_v1.v1.html">v1</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getDomains">getDomains(x__xgafv=None)</a></code></p>
79<p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p>
80<p class="toc_element">
81 <code><a href="#getEntities">getEntities(x__xgafv=None)</a></code></p>
82<p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p>
83<p class="toc_element">
84 <code><a href="#getHelp">getHelp(x__xgafv=None)</a></code></p>
85<p class="firstline">Get help information for the RDAP API, including links to documentation.</p>
86<p class="toc_element">
87 <code><a href="#getIp">getIp(x__xgafv=None)</a></code></p>
88<p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p>
89<p class="toc_element">
90 <code><a href="#getNameservers">getNameservers(x__xgafv=None)</a></code></p>
91<p class="firstline">The RDAP API recognizes this command from the RDAP specification but</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="getDomains">getDomains(x__xgafv=None)</code>
95 <pre>The RDAP API recognizes this command from the RDAP specification but
96does not support it. The response is a formatted 501 error.
97
98Args:
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # Response to a general RDAP query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700108 &quot;title&quot;: &quot;A String&quot;, # Error title.
109 &quot;notices&quot;: [ # Notices applying to this response.
110 { # Notices object defined in [section 4.3 of RFC
111 # 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
112 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
113 &quot;description&quot;: [ # Description of the notice.
114 &quot;A String&quot;,
115 ],
116 &quot;type&quot;: &quot;A String&quot;, # Type values defined in [section 10.2.1 of RFC
117 # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a
118 # whole response: &quot;result set truncated due to authorization&quot;, &quot;result set
119 # truncated due to excessive load&quot;, &quot;result set truncated due to
120 # unexplainable reasons&quot;.
121 &quot;links&quot;: [ # Link to a document containing more information.
122 { # Links object defined in [section 4.2 of RFC
123 # 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
124 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
125 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
126 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
127 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
128 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
129 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
130 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
131 },
132 ],
133 },
134 ],
135 &quot;description&quot;: [ # Error description.
136 &quot;A String&quot;,
137 ],
138 &quot;rdapConformance&quot;: [ # RDAP conformance level.
139 &quot;A String&quot;,
140 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;lang&quot;: &quot;A String&quot;, # Error language code. Error response info fields are defined in [section 6
142 # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
143 &quot;jsonResponse&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to &quot;application/json+rdap&quot;.
144 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
145 # an HTML page.
146 #
147 #
148 # This message can be used both in streaming and non-streaming API methods in
149 # the request as well as the response.
150 #
151 # It can be used as a top-level request field, which is convenient if one
152 # wants to extract parameters from either the URL or HTTP template into the
153 # request fields and also want access to the raw HTTP body.
154 #
155 # Example:
156 #
157 # message GetResourceRequest {
158 # // A unique request id.
159 # string request_id = 1;
160 #
161 # // The raw HTTP body is bound to this field.
162 # google.api.HttpBody http_body = 2;
163 # }
164 #
165 # service ResourceService {
166 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
167 # rpc UpdateResource(google.api.HttpBody) returns
168 # (google.protobuf.Empty);
169 # }
170 #
171 # Example with streaming methods:
172 #
173 # service CaldavService {
174 # rpc GetCalendar(stream google.api.HttpBody)
175 # returns (stream google.api.HttpBody);
176 # rpc UpdateCalendar(stream google.api.HttpBody)
177 # returns (stream google.api.HttpBody);
178 # }
179 #
180 # Use of this type only changes how the request and response bodies are
181 # handled, all other features will continue to work unchanged.
182 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
183 # for streaming APIs.
184 {
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 ],
188 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
189 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
190 },
191 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="getEntities">getEntities(x__xgafv=None)</code>
197 <pre>The RDAP API recognizes this command from the RDAP specification but
198does not support it. The response is a formatted 501 error.
199
200Args:
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # Response to a general RDAP query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700210 &quot;title&quot;: &quot;A String&quot;, # Error title.
211 &quot;notices&quot;: [ # Notices applying to this response.
212 { # Notices object defined in [section 4.3 of RFC
213 # 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
214 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
215 &quot;description&quot;: [ # Description of the notice.
216 &quot;A String&quot;,
217 ],
218 &quot;type&quot;: &quot;A String&quot;, # Type values defined in [section 10.2.1 of RFC
219 # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a
220 # whole response: &quot;result set truncated due to authorization&quot;, &quot;result set
221 # truncated due to excessive load&quot;, &quot;result set truncated due to
222 # unexplainable reasons&quot;.
223 &quot;links&quot;: [ # Link to a document containing more information.
224 { # Links object defined in [section 4.2 of RFC
225 # 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
226 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
227 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
228 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
229 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
230 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
231 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
232 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
233 },
234 ],
235 },
236 ],
237 &quot;description&quot;: [ # Error description.
238 &quot;A String&quot;,
239 ],
240 &quot;rdapConformance&quot;: [ # RDAP conformance level.
241 &quot;A String&quot;,
242 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700243 &quot;lang&quot;: &quot;A String&quot;, # Error language code. Error response info fields are defined in [section 6
244 # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
245 &quot;jsonResponse&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to &quot;application/json+rdap&quot;.
246 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
247 # an HTML page.
248 #
249 #
250 # This message can be used both in streaming and non-streaming API methods in
251 # the request as well as the response.
252 #
253 # It can be used as a top-level request field, which is convenient if one
254 # wants to extract parameters from either the URL or HTTP template into the
255 # request fields and also want access to the raw HTTP body.
256 #
257 # Example:
258 #
259 # message GetResourceRequest {
260 # // A unique request id.
261 # string request_id = 1;
262 #
263 # // The raw HTTP body is bound to this field.
264 # google.api.HttpBody http_body = 2;
265 # }
266 #
267 # service ResourceService {
268 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
269 # rpc UpdateResource(google.api.HttpBody) returns
270 # (google.protobuf.Empty);
271 # }
272 #
273 # Example with streaming methods:
274 #
275 # service CaldavService {
276 # rpc GetCalendar(stream google.api.HttpBody)
277 # returns (stream google.api.HttpBody);
278 # rpc UpdateCalendar(stream google.api.HttpBody)
279 # returns (stream google.api.HttpBody);
280 # }
281 #
282 # Use of this type only changes how the request and response bodies are
283 # handled, all other features will continue to work unchanged.
284 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
285 # for streaming APIs.
286 {
287 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
288 },
289 ],
290 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
291 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
292 },
293 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700294 }</pre>
295</div>
296
297<div class="method">
298 <code class="details" id="getHelp">getHelp(x__xgafv=None)</code>
299 <pre>Get help information for the RDAP API, including links to documentation.
300
301Args:
302 x__xgafv: string, V1 error format.
303 Allowed values
304 1 - v1 error format
305 2 - v2 error format
306
307Returns:
308 An object of the form:
309
310 { # Message that represents an arbitrary HTTP body. It should only be used for
311 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
312 # an HTML page.
313 #
314 #
315 # This message can be used both in streaming and non-streaming API methods in
316 # the request as well as the response.
317 #
318 # It can be used as a top-level request field, which is convenient if one
319 # wants to extract parameters from either the URL or HTTP template into the
320 # request fields and also want access to the raw HTTP body.
321 #
322 # Example:
323 #
324 # message GetResourceRequest {
325 # // A unique request id.
326 # string request_id = 1;
327 #
328 # // The raw HTTP body is bound to this field.
329 # google.api.HttpBody http_body = 2;
330 # }
331 #
332 # service ResourceService {
333 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
334 # rpc UpdateResource(google.api.HttpBody) returns
335 # (google.protobuf.Empty);
336 # }
337 #
338 # Example with streaming methods:
339 #
340 # service CaldavService {
341 # rpc GetCalendar(stream google.api.HttpBody)
342 # returns (stream google.api.HttpBody);
343 # rpc UpdateCalendar(stream google.api.HttpBody)
344 # returns (stream google.api.HttpBody);
345 # }
346 #
347 # Use of this type only changes how the request and response bodies are
348 # handled, all other features will continue to work unchanged.
349 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
350 # for streaming APIs.
351 {
352 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
353 },
354 ],
355 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
356 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
357 }</pre>
358</div>
359
360<div class="method">
361 <code class="details" id="getIp">getIp(x__xgafv=None)</code>
362 <pre>The RDAP API recognizes this command from the RDAP specification but
363does not support it. The response is a formatted 501 error.
364
365Args:
366 x__xgafv: string, V1 error format.
367 Allowed values
368 1 - v1 error format
369 2 - v2 error format
370
371Returns:
372 An object of the form:
373
374 { # Message that represents an arbitrary HTTP body. It should only be used for
375 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
376 # an HTML page.
377 #
378 #
379 # This message can be used both in streaming and non-streaming API methods in
380 # the request as well as the response.
381 #
382 # It can be used as a top-level request field, which is convenient if one
383 # wants to extract parameters from either the URL or HTTP template into the
384 # request fields and also want access to the raw HTTP body.
385 #
386 # Example:
387 #
388 # message GetResourceRequest {
389 # // A unique request id.
390 # string request_id = 1;
391 #
392 # // The raw HTTP body is bound to this field.
393 # google.api.HttpBody http_body = 2;
394 # }
395 #
396 # service ResourceService {
397 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
398 # rpc UpdateResource(google.api.HttpBody) returns
399 # (google.protobuf.Empty);
400 # }
401 #
402 # Example with streaming methods:
403 #
404 # service CaldavService {
405 # rpc GetCalendar(stream google.api.HttpBody)
406 # returns (stream google.api.HttpBody);
407 # rpc UpdateCalendar(stream google.api.HttpBody)
408 # returns (stream google.api.HttpBody);
409 # }
410 #
411 # Use of this type only changes how the request and response bodies are
412 # handled, all other features will continue to work unchanged.
413 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
414 # for streaming APIs.
415 {
416 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
417 },
418 ],
419 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
420 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
421 }</pre>
422</div>
423
424<div class="method">
425 <code class="details" id="getNameservers">getNameservers(x__xgafv=None)</code>
426 <pre>The RDAP API recognizes this command from the RDAP specification but
427does not support it. The response is a formatted 501 error.
428
429Args:
430 x__xgafv: string, V1 error format.
431 Allowed values
432 1 - v1 error format
433 2 - v2 error format
434
435Returns:
436 An object of the form:
437
438 { # Response to a general RDAP query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700439 &quot;title&quot;: &quot;A String&quot;, # Error title.
440 &quot;notices&quot;: [ # Notices applying to this response.
441 { # Notices object defined in [section 4.3 of RFC
442 # 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
443 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
444 &quot;description&quot;: [ # Description of the notice.
445 &quot;A String&quot;,
446 ],
447 &quot;type&quot;: &quot;A String&quot;, # Type values defined in [section 10.2.1 of RFC
448 # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a
449 # whole response: &quot;result set truncated due to authorization&quot;, &quot;result set
450 # truncated due to excessive load&quot;, &quot;result set truncated due to
451 # unexplainable reasons&quot;.
452 &quot;links&quot;: [ # Link to a document containing more information.
453 { # Links object defined in [section 4.2 of RFC
454 # 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
455 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
456 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
457 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
458 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
459 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
460 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
461 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
462 },
463 ],
464 },
465 ],
466 &quot;description&quot;: [ # Error description.
467 &quot;A String&quot;,
468 ],
469 &quot;rdapConformance&quot;: [ # RDAP conformance level.
470 &quot;A String&quot;,
471 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700472 &quot;lang&quot;: &quot;A String&quot;, # Error language code. Error response info fields are defined in [section 6
473 # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
474 &quot;jsonResponse&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for # HTTP response with content type set to &quot;application/json+rdap&quot;.
475 # payload formats that can&#x27;t be represented as JSON, such as raw binary or
476 # an HTML page.
477 #
478 #
479 # This message can be used both in streaming and non-streaming API methods in
480 # the request as well as the response.
481 #
482 # It can be used as a top-level request field, which is convenient if one
483 # wants to extract parameters from either the URL or HTTP template into the
484 # request fields and also want access to the raw HTTP body.
485 #
486 # Example:
487 #
488 # message GetResourceRequest {
489 # // A unique request id.
490 # string request_id = 1;
491 #
492 # // The raw HTTP body is bound to this field.
493 # google.api.HttpBody http_body = 2;
494 # }
495 #
496 # service ResourceService {
497 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
498 # rpc UpdateResource(google.api.HttpBody) returns
499 # (google.protobuf.Empty);
500 # }
501 #
502 # Example with streaming methods:
503 #
504 # service CaldavService {
505 # rpc GetCalendar(stream google.api.HttpBody)
506 # returns (stream google.api.HttpBody);
507 # rpc UpdateCalendar(stream google.api.HttpBody)
508 # returns (stream google.api.HttpBody);
509 # }
510 #
511 # Use of this type only changes how the request and response bodies are
512 # handled, all other features will continue to work unchanged.
513 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response
514 # for streaming APIs.
515 {
516 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
517 },
518 ],
519 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
520 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
521 },
522 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700523 }</pre>
524</div>
525
526</body></html>