• Created by Unknown User (anna), last modified on May 22, 2014

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

getCommunications

Base URL/api/v1/api.php?target=peering&action=getCommunications
DescriptionReturns all communication data on peers at a particular exchange.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"65 records found.","data":[{"name":"1&1 Internet","asn":"8560","request_status":null,"qualified":null,"is_peer":false,"id":"262","log_data":[]},{"name":"Akamai Technologies","asn":"20940","request_status":null,"qualified":null,"is_peer":false,"id":"2","log_data":[]},{"name":"Amazon.com","asn":"16509","request_status":null,"qualified":null,"is_peer":false,"id":"1418","log_data":[]},{"name":"Atrato IP Networks","asn":"5580","request_status":null,"qualified":null,"is_peer":false,"id":"2283","log_data":[]},{"name":"OVH","asn":"16276","request_status":null,"qualified":null,"is_peer":false,"id":"1264","log_data":[]},{"name":"Verisign","asn":"7342","request_status":null,"qualified":null,"is_peer":false,"id":"873","log_data":[]},{"name":"Walmart.com","asn":"17374","request_status":null,"qualified":null,"is_peer":false,"id":"627","log_data":[]},{"name":"Windstream Communications","asn":"7029","request_status":null,"qualified":null,"is_peer":false,"id":"1820","log_data":[]},{"name":"Yahoo!","asn":"10310","request_status":null,"qualified":null,"is_peer":false,"id":"27","log_data":[]},{"name":"Zayo","asn":"19092","request_status":null,"qualified":null,"is_peer":false,"id":"3611","log_data":[]},{"name":"Zayo (Abovenet Communications Inc.)","asn":"6461","request_status":null,"qualified":null,"is_peer":false,"id":"541","log_data":[]},{"name":"tw telecom","asn":"4323","request_status":null,"qualified":null,"is_peer":false,"id":"540","log_data":[]}]}
ERROR{'success':0, 'message':'error message'}
Required Parameters
Name
Type
Example
Description
public_idINTEGER1The unique numerical identifier of the exchange to retrieve peering communicaiton records for.
Example URL/api/v1/api.php?target=peering&action=getCommunications&public_id=1

getPeers

URL/api/v1/api.php?target=peering&action=getPeers
DescriptionReturns a list of all peers available at an exchange
ReturnsExamples: 
SUCCESSFUL: {"success":1,"message":"184 peers found.","data":[{"id":"262","public_id":"1","asn":"8560","name":"1&1 Internet","qualified":true,"is_peer":0,"request_status":"sent","info_prefixes":"150","public_ips":[],"contacts":[],"log_data":[]},"id":"286","public_id":null,"asn":"3856","name":"Packet Clearing House","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"100","public_ips":[],"contacts":[],"log_data":[]},{"id":"890","public_id":null,"asn":"13768","name":"PEER 1 Hosting","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"3000","public_ips":[],"contacts":[],"log_data":[]},{"id":"1676","public_id":null,"asn":"3737","name":"PenTeleData","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"80","public_ips":[],"contacts":[],"log_data":[]},{"id":"1560","public_id":null,"asn":"23265","name":"Pocketinet Communications, Inc.","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"200","public_ips":[],"contacts":[],"log_data":[]},{"id":"576","public_id":null,"asn":"32787","name":"Prolexic","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"500","public_ips":[],"contacts":[],"log_data":[]},"id":"353","public_id":null,"asn":"27524","name":"Xeex Communications","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"3000","public_ips":[],"contacts":[],"log_data":[]},{"id":"27","public_id":null,"asn":"10310","name":"Yahoo!","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"500","public_ips":[],"contacts":[],"log_data":[]},{"id":"1751","public_id":null,"asn":"13238","name":"Yandex LLC","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"60","public_ips":[],"contacts":[],"log_data":[]},{"id":"4078","public_id":null,"asn":"19468","name":"YieldBuild Inc","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"5","public_ips":[],"contacts":[],"log_data":[]},{"id":"541","public_id":null,"asn":"6461","name":"Zayo (Abovenet Communications Inc.)","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"20000","public_ips":[],"contacts":[],"log_data":[]},{"id":"2351","public_id":null,"asn":"14824","name":"Zynga Game Network, Inc.","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":null,"public_ips":[],"contacts":[],"log_data":[]}]} 
ERROR: {"success":1,"message":"No peers found."}
Required Parameters
Name
Type
Example
Description
public_idINTEGER1The unique numerical identifier of the exchange to retrieve peering communicaiton records for.
Optional Parameters
Name
Type
Example
Description
    
Example URL/api/v1/api.php?target=peering&action=getPeers&public_id=1

getPeers

URL/api/v1/api.php?target=peering&action=getPeers
DescriptionReturns a list of all peers available at an exchange
ReturnsExamples: 
SUCCESSFUL: {"success":1,"message":"184 peers found.","data":[{"id":"262","public_id":"1","asn":"8560","name":"1&1 Internet","qualified":true,"is_peer":0,"request_status":"sent","info_prefixes":"150","public_ips":[],"contacts":[],"log_data":[]},"id":"286","public_id":null,"asn":"3856","name":"Packet Clearing House","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"100","public_ips":[],"contacts":[],"log_data":[]},{"id":"890","public_id":null,"asn":"13768","name":"PEER 1 Hosting","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"3000","public_ips":[],"contacts":[],"log_data":[]},{"id":"1676","public_id":null,"asn":"3737","name":"PenTeleData","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"80","public_ips":[],"contacts":[],"log_data":[]},{"id":"1560","public_id":null,"asn":"23265","name":"Pocketinet Communications, Inc.","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"200","public_ips":[],"contacts":[],"log_data":[]},{"id":"576","public_id":null,"asn":"32787","name":"Prolexic","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"500","public_ips":[],"contacts":[],"log_data":[]},"id":"353","public_id":null,"asn":"27524","name":"Xeex Communications","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"3000","public_ips":[],"contacts":[],"log_data":[]},{"id":"27","public_id":null,"asn":"10310","name":"Yahoo!","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"500","public_ips":[],"contacts":[],"log_data":[]},{"id":"1751","public_id":null,"asn":"13238","name":"Yandex LLC","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"60","public_ips":[],"contacts":[],"log_data":[]},{"id":"4078","public_id":null,"asn":"19468","name":"YieldBuild Inc","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"5","public_ips":[],"contacts":[],"log_data":[]},{"id":"541","public_id":null,"asn":"6461","name":"Zayo (Abovenet Communications Inc.)","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":"20000","public_ips":[],"contacts":[],"log_data":[]},{"id":"2351","public_id":null,"asn":"14824","name":"Zynga Game Network, Inc.","qualified":true,"is_peer":0,"request_status":null,"info_prefixes":null,"public_ips":[],"contacts":[],"log_data":[]}]} 
ERROR: {"success":1,"message":"No peers found."}
Required Parameters

None

Optional Parameters
Name
Type
Example
Description
public_idINTEGER1The unique numerical identifier of the exchange to retrieve peering communication records for.
idINT1The unique numerical identifier of the peer in peeringDB.
asnINT4436 
nameSTRINGGTT 
akaSTRINGnLayer 
websiteSTRINGhttp://www.gt-t.net 
notes_publicSTRING  
notes_privateSTRING  
irr_as_setSTRINGAS-NLAYER 
info_trafficENUM1 Tbps+enum('Not Disclosed','0-20 Mbps','20-100Mbps','100-1000Mbps','1-5Gbps','5-10Gbps','10-20Gbps','20-50 Gbps','50-100 Gbps','100+ Gbps','100-200 Gbps','200-300 Gbps','300-500 Gbps','500-1000 Gbps','1 Tbps+') DEFAULT 'Not Disclosed'
info_ratioENUMMostly Outboundenum('Not Disclosed','Heavy Outbound','Mostly Outbound','Balanced','Mostly Inbound','Heavy Inbound') DEFAULT 'Not Disclosed'
info_scopeENUMGlobalenum('Not Disclosed','Regional','North America','Asia Pacific','Europe','Africa','South America','Global') DEFAULT NULL
info_typeENUMNSPenum('Not Disclosed','NSP','Content','Cable/DSL/ISP','Enterprise','Educational/Research','Non-Profit') DEFAULT 'Not Disclosed'
info_prefixesINT10000 
info_lookingglassSTRINGhttp://lg.nlayer.net/ 
info_routeserverSTRINGtelnet://route-server.nlayer.net 
info_unicastCHAR1 
info_multicastCHAR  
info_ipv6CHAR1 
policy_urlSTRINGhttp://www.gt-t.net/Peering_policies.aspx 
policy_generalENUMSelectiveenum('Open','Selective','Restrictive','No') DEFAULT NULL
policy_locationsENUMRequired - Internationalenum('Not Required','Preferred','Required - US','Required - International') DEFAULT NULL
policy_ratioENUMNoenum('Yes','No') DEFAULT NULL
policy_contractsENUMNot Requiredenum('Not Required','Private Only','Required') DEFAULT NULL
policy_nopublicENUMNenum('Y','N') NOT NULL DEFAULT 'N'
policy_noprivateENUMNenum('Y','N') NOT NULL DEFAULT 'N'
date_createdDATETIME2013-03-21 15:36:42Date the peeringdb entry was created
date_lastupdatedDATETIME2013-03-21 15:36:42Date the peeringdb entry was last updated
include_public_ipsBOOL TRUE Returns a list of all public facing IPs
include_contactsBOOLTRUEReturns a list of all contacts associated with peer(s)
include_log_dataBOOLTRUEReturns a list of all log data associated with the peer(s) (use with care)
Example URL/api/v1/api.php?target=peering&action=getPeers&public_id=1
  • No labels