Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

This API call only applies to Armor Complete users.

The Create L2L API creates a new L2L tunnel.  


Sample request

POST https://api.armor.com/l2l/
{
  "name":"ME4",
  "psk":"Secur3_K3Y",
  "peerIp":"10.1.1.3",
  "dhGroup":"dh2",
  "isEnabled":true,
  "enablePfs":true,
  "localSubnets":[
     "100.64.0.66/32"
  ],
  "peerSubnets":[
     "10.1.0.0/24"
  ],
  "authentication":"psk",
  "encryption":"aes256",
  "localIp":"146.88.118.5",
  "edgeId":4,
  "peerId":"10.1.1.0"
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/l2lPOST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
nameName of tunnelStringRequiredME4
pskPre-shared keyStringRequiredSecur3_K3Y
dhGroupDiffie-Hellman groupStringRequireddh2
isEnabledFlag to enable to disableBoolRequiredtrue
enablePfsEnable perfect forward secrecyBoolRequiredtrue
localSubnetsLocal subnets to tunnelArrayRequired100.64.0.66/32
peerSubnetsPeer subnets to tunnelArrayRequired10.1.0.0/24
authenticationType of authenticationStringRequiredpsk
encryptionType of encryption to useStringRequiredaes256
localIpLocal Peer IP addressStringRequired146.88.118.5
edgeIdid of edge in which the tunnel is establishedIntegerRequired4
peerIdRemote peer addressStringRequired10.1.1.0

Sample return

StatusResponse
200
{
  "location": "DFW01",
  "zone": "DFW01T01-VC03",
  "lastModified": "2015-01-06T23:06:09.893",
  "peerId": "1.2.3.4",
  "encryption": "3des",
  "enablePfs": true,
  "dhGroup": "dh2",
  "localSubnets": [
    "100.64.0.64/32"
  ],
  "peerSubnets": [
    "10.1.1.0/24"
  ],
  "psk": null,
  "authentication": "psk",
  "configurationId": 4,
  "id": 24,
  "name": "ME",
  "localIp": "146.88.118.5",
  "peerIp": "1.2.3.4",
  "isEnabled": true,
  "notes": null,
  "tags": []
}
400
Bad Request