Network Edge APIs | Equinix Product Documentation

List Allowed Interfaces

Request

Returns the interface details for a device type with a chosen configuration. You must pass the device type as the path parameter.

Security

BearerAuth

Path

deviceTypestring(DeviceTypeCode)required

Device type code. PA-VM.

Enum:"C8000V""C8000V-SDWAN""PA-VM""ASAV""CGUARD""FG-VM""MERAKI-VMX""PRISMA-SDWAN""INFOBLOX""AVIATRIX_EDGE"

Example:PA-VM

Query

deviceManagementTypestringrequired

Device management type. SELF-CONFIGURED

Enum:"SELF-CONFIGURED""EQUINIX-CONFIGURED"

Example:deviceManagementType=SELF-CONFIGURED

modestring

License mode, either Subscription or BYOL.

Enum:"Subscription""BYOL"

Example:mode=Subscription

clusterboolean

Whether you want a cluster device.

Example:cluster=false

sdwanboolean

Whether you want an SD-WAN device.

Example:sdwan=false

connectivitystring

Type of connectivity you want. INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. PRIVATE devices do not have ACLs or bandwidth.

Enum:"INTERNET-ACCESS""PRIVATE""INTERNET-ACCESS-WITH-PRVT-MGMT"

Example:connectivity=INTERNET-ACCESS

coreinteger

The desired number of cores.

Example:core=4

memoryinteger

Desired memory.

Example:memory=4

unitstring

Unit of memory. GB or MB.

Example:unit=GB

flavorstring

Flavor of device.

Example:flavor=small

versionstring

Version.

Example:version=17.06.01

softwarePkgstring

Software package.

Example:softwarePkg=SEC

Payload

// No request payload

Responses

Success

Bodyapplication/json

interfaceProfilesArray of objects(AllowedInterfaceProfiles)

List of allowed interface profiles

Response

{
  "interfaceProfiles": [
    { … }
  ]
}