forked from dev-magdy/Shreyash-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
domainsdb-openapi.yaml
398 lines (398 loc) · 9.37 KB
/
domainsdb-openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
openapi: 3.0.0
servers:
- url: 'https://api.domainsdb.info/v1'
paths:
/domains/search:
get:
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Search_Results'
'403':
description: api_key is not valid
'404':
description: Results not found
summary: Domains Database Search
operationId: get_domains_search
parameters:
- name: api_key
in: query
description: API key
schema:
type: string
- name: date
in: query
description: Request date
schema:
type: string
- name: page
in: query
description: Search page to request
schema:
type: string
- name: limit
in: query
description: Results per page
schema:
type: integer
default: 50
- name: domain
in: query
description: Domain includes
schema:
type: string
- name: zone
in: query
description: In Zone
schema:
type: string
- name: country
in: query
description: Hosting Country
schema:
type: string
- name: isDead
in: query
description: 'Dead or Not, default not'
schema:
type: boolean
- name: A
in: query
description: A record includes
schema:
type: string
- name: NS
in: query
description: NS record includes
schema:
type: string
- name: CNAME
in: query
description: CNAME record includes
schema:
type: string
- name: MX
in: query
description: MX record includes
schema:
type: string
- name: TXT
in: query
description: TXT record includes
schema:
type: string
tags:
- domains/
/info/api:
get:
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/API_Key_Info'
operationId: get_info_api
parameters:
- name: api_key
in: query
description: API key
schema:
type: string
tags:
- info/
/info/stat/:
get:
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Zone_stats'
summary: Returns overall stagtistics
operationId: get_info_stat
parameters:
- name: page
in: query
description: Search page to request
schema:
type: string
- name: limit
in: query
description: Results per page
schema:
type: integer
default: 50
tags:
- info/
'/info/stat/{zone}':
parameters:
- name: zone
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Zone_stats'
'404':
description: Zone not found.
summary: Returns statistics for specific zone
operationId: get_info_stat_zone
parameters:
- name: page
in: query
description: Search page to request
schema:
type: string
- name: limit
in: query
description: Results per page
schema:
type: integer
default: 50
tags:
- info/
/info/tld/:
get:
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Zone_info'
summary: Returns overall Tld info
operationId: get_info_tld
tags:
- info/
'/info/tld/{zone}':
parameters:
- name: zone
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Zone_info'
'404':
description: Zone not found.
summary: Returns statistics for specific zone
operationId: get_info_tld_zone
parameters:
- name: page
in: query
description: Search page to request
schema:
type: string
- name: limit
in: query
description: Results per page
schema:
type: integer
default: 50
tags:
- info/
info:
title: Domains-Index API
version: '1.0'
description: Domains-Index database powered API
tags:
- name: default
description: Default namespace
- name: info/
description: TLD Statistics
- name: domains/
description: Domains Database
components:
responses:
ParseError:
description: When a mask can't be parsed
MaskError:
description: When any error occurs on mask
schemas:
Domains:
properties:
domain:
type: string
description: Domain name
create_date:
type: string
format: date-time
description: Domain creation date
update_date:
type: string
format: date-time
description: Domain last update date
country:
type: string
description: Hosting Country
isDead:
type: string
description: If Domain is Dead
A:
type: array
items:
type: string
description: A record
NS:
type: array
items:
type: string
description: NS record
CNAME:
type: array
items:
type: string
description: CNAME record
MX:
type: array
items:
$ref: '#/components/schemas/MX_records'
TXT:
type: array
items:
type: string
description: TXT record
type: object
Zone_stats:
allOf:
- $ref: '#/components/schemas/Response_Parameters'
- properties:
statistics:
type: array
items:
$ref: '#/components/schemas/Zone_statistics'
type: object
Response_Parameters:
required:
- time
properties:
total:
type: integer
description: Total days reported
time:
type: string
description: Time took
next_page:
type: string
description: Next page id
type: object
Zone_statistics:
required:
- date
- dec
- inc
- total
- zone
properties:
zone:
type: string
description: TLD name
date:
type: string
format: date-time
description: Report Date
dec:
type: integer
description: Increase
inc:
type: integer
description: Decrease
total:
type: integer
description: Total number of records
type: object
Zone_info:
required:
- type
- zone
properties:
zone:
type: string
description: TLD name
type:
type: string
description: TLD type
includes:
type: array
items:
type: string
description: Sub TLDs included
in_bundles:
type: array
items:
type: string
description: Sub TLDs included
description:
type: array
items:
type: string
description: Sub TLDs included
type: object
API_Key_Info:
properties:
success:
type: string
description: State
license:
type: string
description: State
item_id:
type: string
description: State
item_name:
type: string
description: State
expires:
type: string
description: State
customer_name:
type: string
description: State
customer_email:
type: string
description: State
license_limit:
type: string
description: State
price_id:
type: string
description: State
type: object
Search_Results:
allOf:
- $ref: '#/components/schemas/Response_Parameters'
- properties:
domains:
type: array
items:
$ref: '#/components/schemas/Domains'
type: object
MX_records:
properties:
exchange:
type: string
description: MX domain
priority:
type: integer
type: object