openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 14 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"/v1"}],"info":{"description":"Domains-Index database powered API","title":"Domains-Index API","version":"1.0","x-apisguru-categories":["hosting"],"x-logo":{"url":"https://pbs.twimg.com/profile_images/769216960504532996/rctG95A0_400x400.jpg"},"x-origin":[{"format":"openapi","url":"https://api.domains-index.com/v1/swagger.json","version":"3.0"}],"x-providerName":"domainsdb.info"},"tags":[{"description":"Default namespace","name":"default"},{"description":"TLD Statistics","name":"info/"},{"description":"Domains Database","name":"domains/"}],"paths":{"/domains/search":{"get":{"operationId":"get_search_domain_item","parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}},{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}},{"description":"Domain includes","in":"query","name":"domain","schema":{"type":"string"}},{"description":"In Zone","in":"query","name":"zone","schema":{"type":"string"}},{"description":"Hosting Country","in":"query","name":"country","schema":{"type":"string"}},{"description":"Dead or Not, default not","in":"query","name":"isDead","schema":{"type":"boolean"}},{"description":"A record includes","in":"query","name":"A","schema":{"type":"string"}},{"description":"NS record includes","in":"query","name":"NS","schema":{"type":"string"}},{"description":"CNAME record includes","in":"query","name":"CNAME","schema":{"type":"string"}},{"description":"MX record includes","in":"query","name":"MX","schema":{"type":"string"}},{"description":"TXT record includes","in":"query","name":"TXT","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search_Results"}}},"description":"Success"},"403":{"description":"api_key is not valid"},"404":{"description":"Results not found"}},"summary":"Domains Database Search","tags":["domains/"]}},"/domains/tld/{zone_id}":{"get":{"operationId":"get_tld_domain_item","parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}},{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}},{"description":"Domain includes","in":"query","name":"domain","schema":{"type":"string"}},{"description":"Hosting Country","in":"query","name":"country","schema":{"type":"string"}},{"description":"Dead or Not, default not","in":"query","name":"isDead","schema":{"type":"boolean"}},{"description":"A record includes","in":"query","name":"A","schema":{"type":"string"}},{"description":"NS record includes","in":"query","name":"NS","schema":{"type":"string"}},{"description":"CNAME record includes","in":"query","name":"CNAME","schema":{"type":"string"}},{"description":"MX record includes","in":"query","name":"MX","schema":{"type":"string"}},{"description":"TXT record includes","in":"query","name":"TXT","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search_Results"}}},"description":"Success"},"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Get TLD records","tags":["domains/"]},"parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"string"}}]},"/domains/tld/{zone_id}/download":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}}],"responses":{"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Download Whole Dataset for TLD","tags":["domains/"]},"parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"string"}}]},"/domains/tld/{zone_id}/search":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}},{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}},{"description":"Domain includes","in":"query","name":"domain","schema":{"type":"string"}},{"description":"Hosting Country","in":"query","name":"country","schema":{"type":"string"}},{"description":"Dead or Not, default not","in":"query","name":"isDead","schema":{"type":"boolean"}},{"description":"A record includes","in":"query","name":"A","schema":{"type":"string"}},{"description":"NS record includes","in":"query","name":"NS","schema":{"type":"string"}},{"description":"CNAME record includes","in":"query","name":"CNAME","schema":{"type":"string"}},{"description":"MX record includes","in":"query","name":"MX","schema":{"type":"string"}},{"description":"TXT record includes","in":"query","name":"TXT","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search_Results"}}},"description":"Success"},"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Domains Search for TLD","tags":["domains/"]},"parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"type":"string"}}]},"/domains/updates/added":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}},{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search_Results"}}},"description":"Success"},"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Get added domains, latest if date not specified","tags":["domains/"]}},"/domains/updates/added/download":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}}],"responses":{"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Download added domains, latest if date not specified","tags":["domains/"]}},"/domains/updates/deleted":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}},{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search_Results"}}},"description":"Success"},"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Get deleted domains, latest if date not specified","tags":["domains/"]}},"/domains/updates/deleted/download":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}},{"description":"Request date","in":"query","name":"date","schema":{"type":"string"}}],"responses":{"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"Download deleted domains, latest if date not specified","tags":["domains/"]}},"/domains/updates/list":{"get":{"parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update_model"}}},"description":"Success"},"403":{"description":"No api_key or it's not valid"},"404":{"description":"Results not found"}},"summary":"List of updates","tags":["domains/"]}},"/info/api":{"get":{"operationId":"get_api_info_item","parameters":[{"description":"API key","in":"query","name":"api_key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Key_Info"}}},"description":"Success"}},"tags":["info/"]}},"/info/stat/":{"get":{"operationId":"get_statistics_collection","parameters":[{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Zone_stats"},"type":"array"}}},"description":"Success"}},"summary":"Returns overall stagtistics","tags":["info/"]}},"/info/stat/{zone}":{"get":{"operationId":"get_statistics_item","parameters":[{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zone_stats"}}},"description":"Success"},"404":{"description":"Zone not found."}},"summary":"Returns statistics for specific zone","tags":["info/"]},"parameters":[{"in":"path","name":"zone","required":true,"schema":{"type":"string"}}]},"/info/tld/":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Zone_info"},"type":"array"}}},"description":"Success"}},"summary":"Returns overall Tld info","tags":["info/"]}},"/info/tld/{zone}":{"get":{"parameters":[{"description":"Search page to request","in":"query","name":"page","schema":{"type":"string"}},{"description":"Results per page","in":"query","name":"limit","schema":{"default":50,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zone_info"}}},"description":"Success"},"404":{"description":"Zone not found."}},"summary":"Returns statistics for specific zone","tags":["info/"]},"parameters":[{"in":"path","name":"zone","required":true,"schema":{"type":"string"}}]}},"components":{"responses":{"MaskError":{"description":"When any error occurs on mask"},"ParseError":{"description":"When a mask can't be parsed"}},"schemas":{"API_Key_Info":{"properties":{"customer_email":{"description":"State","type":"string"},"customer_name":{"description":"State","type":"string"},"expires":{"description":"State","type":"string"},"item_id":{"description":"State","type":"string"},"item_name":{"description":"State","type":"string"},"license":{"description":"State","type":"string"},"license_limit":{"description":"State","type":"string"},"price_id":{"description":"State","type":"string"},"success":{"description":"State","type":"string"}},"type":"object"},"Domains":{"properties":{"A":{"items":{"description":"A record","type":"string"},"type":"array"},"CNAME":{"items":{"description":"CNAME record","type":"string"},"type":"array"},"MX":{"items":{"$ref":"#/components/schemas/MX_records"},"type":"array"},"NS":{"items":{"description":"NS record","type":"string"},"type":"array"},"TXT":{"items":{"description":"TXT record","type":"string"},"type":"array"},"country":{"description":"Hosting Country","type":"string"},"create_date":{"description":"Domain creation date","format":"date-time","type":"string"},"domain":{"description":"Domain name","type":"string"},"isDead":{"description":"If Domain is Dead","type":"string"},"update_date":{"description":"Domain last update date","format":"date-time","type":"string"}},"type":"object"},"MX_records":{"properties":{"exchange":{"description":"MX domain","type":"string"},"priority":{"type":"integer"}},"type":"object"},"Response_Parameters":{"properties":{"next_page":{"description":"Next page id","type":"string"},"time":{"description":"Time took","type":"string"},"total":{"description":"Total days reported","type":"integer"}},"required":["time"],"type":"object"},"Search_Results":{"allOf":[{"$ref":"#/components/schemas/Response_Parameters"},{"properties":{"domains":{"items":{"$ref":"#/components/schemas/Domains"},"type":"array"}},"type":"object"}]},"Update_model":{"properties":{"added":{"description":"Updates added list","type":"string"},"added_download":{"description":"Download link for added","type":"string"},"date":{"description":"Update date","type":"string"},"deleted":{"description":"Updates deleted list","type":"string"},"deleted_download":{"description":"Download link for deleted","type":"string"}},"type":"object"},"Zone_info":{"properties":{"description":{"items":{"description":"Sub TLDs included","type":"string"},"type":"array"},"in_bundles":{"items":{"description":"Sub TLDs included","type":"string"},"type":"array"},"includes":{"items":{"description":"Sub TLDs included","type":"string"},"type":"array"},"type":{"description":"TLD type","type":"string"},"zone":{"description":"TLD name","type":"string"}},"required":["type","zone"],"type":"object"},"Zone_statistics":{"properties":{"date":{"description":"Report Date","format":"date-time","type":"string"},"dec":{"description":"Increase","type":"integer"},"inc":{"description":"Decrease","type":"integer"},"total":{"description":"Total number of records","type":"integer"},"zone":{"description":"TLD name","type":"string"}},"required":["date","dec","inc","total","zone"],"type":"object"},"Zone_stats":{"allOf":[{"$ref":"#/components/schemas/Response_Parameters"},{"properties":{"statistics":{"items":{"$ref":"#/components/schemas/Zone_statistics"},"type":"array"}},"type":"object"}]}}}}