Versions Compared

Old Version 5

changes.mady.by.user Unknown User (anna)

Saved on

compared with

New Version 6

changes.mady.by.user Unknown User (anna)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

deleteSession

URL/api/v1/api.php?target=peering&action=deleteSession
Description Delete sessions matching criteria
Returns

Examples: 
SUCCESSFUL: {"success":1,"message":"1 sessions deleted."}

ERROR: {"success":0,"message":"No sessions found to delete."}

Required Parameters

None

Optional Parameters
Name
Type
Example
Description
idINTEGER41 
public_idINTEGER  
source_asnINTEGER  
source_ipaddrSTRING  
resource_idINTEGER  
peer_asnINTEGER  
peer_nameSTRING  
peer_participant_idINTEGER  
peer_ipaddrSTRING  
peer_hostnameSTRING  
peer_groupSTRING  
passwordINTEGER  
typeSTRING  
stateSTRING  
prfx_maxINTEGER  
prfx_receivedINTEGER  
ip_typeENUM enum('ipv4','ipv6') NOT NULL DEFAULT 'ipv4'
noteSTRING  
createdTIMESTAMP  
modifiedTIMESTAMP  
deletedINTEGER  
public_idINTEGER  
Example URL/api/v1/api.php?target=peering&action=deleteSession&id=171

updateSession

URL/api/v1/api.php?target=peering&action=updateSession
DescriptionUpdates session values with any new values specified 
Returns

Examples: 
SUCCESSFUL:{"success":1,"message":"Session updated: 123.net (AS32787\/1.2.3.4) - (AS12129\/206.126.236.70)","data":{"id":"41","source_asn":"32787","source_ipaddr":"1.2.3.4","resource_id":"422","resource_name":"ar1.inoc.com","peer_asn":"12129","peer_name":"123.net","peer_participant_id":"3899","peer_ipaddr":"206.126.236.70","peer_hostname":null,"peer_group":"group a","public_id":"1","public_name":"Equinix Ashburn","ip_type":"ipv4","type":"Peer","state":"not configured","prfx_max":"10","prfx_received":null,"password":"0","note":"Adding an awesome note."}}

ERROR: 

Required Parameters

None

Optional Parameters
Name
Type
Example
Description
idINTEGER41 
public_idINTEGER  
source_asnINTEGER  
source_ipaddrSTRING  
resource_idINTEGER  
peer_asnINTEGER  
peer_nameSTRING  
peer_participant_idINTEGER  
peer_ipaddrSTRING  
peer_hostnameSTRING  
peer_groupSTRING  
passwordINTEGER  
typeSTRING  
stateSTRING  
prfx_maxINTEGER  
prfx_receivedINTEGER  
ip_typeENUM enum('ipv4','ipv6') NOT NULL DEFAULT 'ipv4'
noteSTRING  
createdTIMESTAMP  
modifiedTIMESTAMP  
deletedINTEGER  
public_idINTEGER  
Example URL/api/v1/api.php?target=peering&action=updateSession&note=Adding+an+awesome+note.&peer_group=group+a