Skip to main content
Index

ACL Template

Get ACL Templates

GET /ne/v1/aclTemplates

 Method  GET
 URL or End Point  /ne/v1/aclTemplates
 Headers  Authorization, Content-Type
 Query Parameters  offset, limit, accountUcmId
 Body  Not applicable

 

Returns the details of device ACL templates.

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/aclTemplates"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameters:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
offset No integer 0   Specifies where to start a page. It is the starting point of the collection returned from the server. 
limit No integer 100   Specifies the page size. 
accountUcmId No string 678907   The unique Id of the account. A reseller querying for a customer's device ACLs can input the accountUcmId of the customer's account. To find out the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get account API.   

 

Sample response: 

{
   "pagination": {
      "offset": 0,
      "limit": 20,
      "total": 9
   },

    "data": [
        {
            "name": "new-tempalate-with-fqdn2",
            "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
            "description": "new template description for DC metro update",
            "inboundRules": [
                {
                    "srcType": "DOMAIN",
                    "seqNo": 1,
                    "fqdn": "equinix.com",
                    "subnets": [
                        "216.221.225.13/32"
                    ],
                    "protocol": "SSH",
                    "srcPort": "22",
                    "dstPort": "any"
                }
            ],
            "metroName": "Ashburn",
            "metroCode": "DC",
            "virtualDeviceName": "myNewVirtualDevice",
            "virtualDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
            "deviceAclstatus": "PROVISIONED",
            "createdBy": "nfv-sit1",
            "createdDate": "2020-09-14T05:36:13.981Z"
        }
    ]
}

 

The description of the response:

Field Name Type Example Values Description
pagination object   An object that has pagination information.
offset integer 0 It is the starting point of the collection returned from the server. 
limit integer 20 The page size. 
total integer 100 The total number of results. 
next string   The next set of records.
previous string   The previous set of records.
content array   An array of device ACLs.
name string new-template-with-fqdn The ACL template name.
uuid string ec68e425-f973-452e-a866-76be5844d0ba The unique ID of the ACL template.
description string New template description. The ACL template description.
inboundRules array   An array that has inboundRules. 
srcType string DOMAIN Source type description.
seqNo integer 1 The sequence number of inboundRules.
fqdn string equinix.com FQDN.
subnets array 216.221.225.13/32 An array of subnets.
protocol string SSH Protocol type.
srcPort string 22 Source port.
dstPort string any Destination port.
metroName string Ashburn The name of the metro.
metroCode string DC The metro code.
virtualDeviceName string myVirtualDevice The name of the virtual device associated with this ACL template.
virtualDeviceUuid string 4cfb5675-5c3f-4275-adba-0c9e3c26c96b The unique Id of the device associated with this ACL template.
deviceACLstatus string PROVISIONED The device ACL status.
createdBy string nfv-sit1 Created by.
createdDate string 2020-09-14T05:36:13:9812 Created date.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.

Get ACL Template {uuid}

GET /ne/v1/aclTemplates/{uuid}

 Method  GET
 URL or End Point  /ne/v1/device/aclTemplates/{uuid}
 Headers  Authorization, Content-Type
 Path Parameter  uuid
 Query Parameter  accountUcmId
 Body  Not applicable

 

Returns the details of an ACL template.

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/aclTemplates/6953b3d7-713d-4412-b6d7-0c5fc5e2a800"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 6953b3d7-713d-4412-b6d7-0c5fc5e2a800   The unique Id an ACL Template.  

 

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountUcmId No string 678907   The unique Id of the account. A reseller querying for a customer's device ACLs can input the accountUcmId of the customer's account. To find out the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get Account {metro}.   

 

Sample response: 

{
    "name": "ACL_Template_1",
    "uuid": "6953b3d7-713d-4412-b6d7-0c5fc5e2a800",
    "description": "ACL_Template_1",
    "inboundRules": [
        {
            "srcType": "DOMAIN",
            "seqNo": 1,
            "fqdn": "equinix.com",
            "subnets": [
                "216.221.225.13/32"
            ],
            "protocol": "TCP",
            "srcPort": "any",
            "dstPort": "any"
        }
    ],
    "metroName": "Silicon Valley",
    "metroCode": "SV",
    "virtualDeviceName": "Test Tanuja",
    "virtualDeviceUuid": "55c1345f-fa59-4e39-813c-1a439a426ac3",
    "deviceAclstatus": "PROVISIONING",
    "createdBy": "nfvsit01",
    "createdDate": "2020-10-03T19:41:17.976Z"
}

 

The description of the response:

Field Name Type Example Values Description
name string new-template-with-fqdn The ACL template name.
uuid string ec68e425-f973-452e-a866-76be5844d0ba The unique ID of the ACL template.
description string New template description. The ACL template description.
inboundRules array   An array that has inboundRules. 
srcType string DOMAIN Source type description.
seqNo integer 1 The sequence number of inboundRules.
fqdn string equinix.com FQDN.
subnets array 216.221.225.13/32 An array of subnets.
protocol string SSH Protocol type.
srcPort string 22 Source port.
dstPort string any Destination port.
metroName string Ashburn The name of the metro.
metroCode string DC The metro code.
virtualDeviceName string Test Device The name of the virtual device associated with this ACL template.
virtualDeviceUuid string 55c1345f-fa59-4e39-813c-1a439a426ac3 The unique Id of the device associated with this ACL template.
deviceACLstatus string PROVISIONING The device ACL status.
createdBy string nfv-sit1 Created by.
createdDate string 2020-09-14T05:36:13:9812 Created date.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.

Create ACL Template

POST /ne/v1/aclTemplates

 Method  POST
 URL or End Point  /ne/v1/aclTemplates
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  name, description, metroCode, inboundRules, srcType, protocol, srcPort, dstPort, fqdn, subnets, seqNo

 

Posts an ACL template. To get the list of subnets for any FQDN, you can call the POST DNSLookup API with the FQDN. Afterwards, to create the ACL template, pass the subnets in the srcType "Domain" in the inboundRules array. 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:

curl -X

POST "https://api.equinix.com/ne/v1/aclTemplates"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d "{
    "name": "testtemplate4",
    "description": "testtemplate4",
    "metroCode": "DA",
    "inboundRules": [
        {
            "srcType": "DOMAIN",
            "protocol": "TCP",
            "srcPort": "any",
            "dstPort": "any",
            "fqdn": "equinix.com",
            "subnets": [
                "216.221.225.13/32"
            ],
            "seqNo": 1
        },
        {
            "srcType": "SUBNET",
            "protocol": "DNS",
            "srcPort": "53",
            "dstPort": "any",
            "subnets": [
                "1.1.1.1/32"
            ],
            "seqNo": 2
        }
    ]
}"

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountUcmId No string 2252619   A reseller creating an ACL template for a customer can pass the accountUcmId of the customer.

 

Body Parameter Name Mandatory Type Example Applicable Values Description
name Yes string

My template name

  ACL template name.
description Yes string My template description   ACL template description
metroCode Yes string DC   Metro code.
inboundRules Yes array     An array of inboundRules.
srcType Yes string DOMAIN DOMAIN, SUBNET Source type. 
protocol Yes string DNS   Protocol.
srcPort Yes string 53   Source port.
dstPort Yes string any   Destination port.
fqdn No string equinix.com   This field is mandatory in case the source type is "DOMAIN."
subnets Yes array [tracecloud.com]   An array of subnets.
seqNo Yes integer 1   The sequence number of the inbound rule.

 

 

Sample response:

201 Created

 

The description of the response payload:

Status Description
201 The ACL Template is created. You can find the unique Id of the ACL template in the location header. 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

Update ACL Template

PUT /ne/v1/aclTempates/{uuid}

 Method  PUT
 URL or End Point  /ne/v1/aclTemplates/{uuid}
 Headers  Authorization, Content-Type
 Query Parameter  accountUcmId
 Path Parameter  uuid
 Body  name, description, metroCode, inboundRules, srcType, protocol, srcPort, dstPort, fqdn, subnets, seqNo

 

Updates an ACL template. 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:

curl -X

PUT "https://api.equinix.com/ne/v1/aclTemplates/f1475-3c7f-447f-b0db-e3bb3af3de16"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d "{
    "name": "testtemplate4",
    "description": "testtemplate4",
    "metroCode": "DA",
    "inboundRules": [
        {
            "srcType": "DOMAIN",
            "protocol": "TCP",
            "srcPort": "any",
            "dstPort": "any",
            "fqdn": "equinix.com",
            "subnets": [
                "216.221.225.13/32"
            ],
            "seqNo": 1
        },
        {
            "srcType": "SUBNET",
            "protocol": "DNS",
            "srcPort": "53",
            "dstPort": "any",
            "subnets": [
                "1.1.1.1/32"
            ],
            "seqNo": 2
        }
    ]
}"

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountUcmId No string 2252619   A reseller creating a device ACL template for a customer can pass the accountUcmId of the customer.

 

Body Parameter Name Mandatory Type Example Applicable Values Description
name Yes string

My template name

  The device ACL template name.
description Yes string My template description   The device ACL template description
metroCode Yes string DC   Metro code.
inboundRules Yes array     An array of inboundRules.
srcType Yes string DOMAIN   Source type.
protocol Yes string DNS   Protocol.
srcPort Yes string 53   Source port.
dstPort Yes string any   Destination port.
fqdn No string equinix.com   This field is mandatory in case the source type is "DOMAIN."
subnets Yes array [tracecloud.com]   An array of subnets.
seqNo Yes integer 1   The sequence number of the inbound rule.

 

 

Sample response:

204 No Content

 

The description of the response payload:

Status Description
204 No Content. The ACL template has been updated. 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

Delete ACL Template {uuid}

DELETE /ne/v1/aclTemplates/{uuid}

 Method  DELETE
 URL or End Point  /ne/v1/aclTemplates/{uuid}
 Headers  Authorization, Content-Type
 Query Parameter  accountUcmId
 Path Parameter  uuid

 

Deletes an ACL template.  

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request. 

curl -X

DELETE "https://api.equinix.com/ne/v1/aclTemplates/5f888d91-d2c5-45bb-9b51-fed99f57f0ac"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

 

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
Uuid Yes string 5f888d91-d2c5-45bb-9b51-fed99f57f0ac   The unique Id of an ACL template.

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountUcmId No   True   The unique Id of the account. A reseller deleting a customer's template can pass the accountUcmId of the customer's account. 

 

Sample response: 

204 No Content: Deletion request accepted.

 

The description of the response is as follows:

HTTP status Description
204 No Content The deletion request was successfully accepted.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.

POST DNS Lookup

POST /ne/v1/dnsLookup

 Method  POST
 URL or End Point  /ne/v1/dnsLookup
 Headers  Authorization, Content-Type
 Path Parameters  NA
 Body Parameters  fqdns, uuid, metroCode

 

Call this API to lookup IP addresses associated with domains of a metro or a virtual device.   

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Curl request:

 

curl -X

POST "https://api.equinix.com/ne/v1/dnsLookup"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d "

{

  "fqdns": [

    "velocloud.net"

  ],

  "metroCode": "DA"

}

"

 

The description of the body parameters is as follows:

 

Parameter Name Mandatory Type Example Applicable Values Description
fqdns Yes string velocloud.net

 

Domain name. Please provide one domain name at a time. 
uuid No string 3da0a663-20d9-4b8f-8c5d-d5cf706840c8   Unique Id of a virtual device.
metroCode Yes string DA   Metro code. 

 

Sample response

 

{

    "velocloud.net": {

        "cdn": false,

        "ips": [

            "104.24.100.23/32",

            "104.24.101.23/32"

        ]

    }

}

 

The description of the response payload is as follows:

 

Field Type Example Values Description
"domain.name" string velocloud.net The domain name that was passed to the API.
cdn boolean false Whether the domain is Content Delivery Domain (CDN). 
ips array

[ "104.24.100.23/32",

            "104.24.101.23/32" ]

An array of IPs. 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.