Package api.equinix.javasdk

Class NetworkEdge

java.lang.Object

api.equinix.javasdk.EquinixClient

api.equinix.javasdk.NetworkEdge

All Implemented Interfaces:

Service, Closeable, AutoCloseable

public final class NetworkEdge
extends EquinixClient
implements Service

The primary entry point for accessing the Equinix Network Edge APIs.

Network Edge provides virtual network devices deployed at Equinix data centers, enabling customers to run network functions (routers, firewalls, SD-WAN) without physical hardware. This class offers typed access to all Network Edge resources including virtual devices, SSH users, ACL templates, VPN connections, BGP peerings, device links, public keys, and backups.

All resource accessors use lazy initialization — internal clients are created on first access and reused for subsequent calls.

Quick Start

 BasicEquinixCredentials credentials = new BasicEquinixCredentials("clientId", "clientSecret");
 NetworkEdge networkEdge = new NetworkEdge(credentials);

 // List all virtual devices
 PaginatedList<Device> devices = networkEdge.devices().list();

 // Create a virtual device with the fluent builder
 Device device = networkEdge.devices()
     .define("my-router")
     .withAccountNumber(accountNumber)
     .inMetro(MetroCode.SV)
     .withDeviceType("CSR1000V")
     .create();

 // Manage SSH users and ACL templates
 PaginatedList<SSHUser> sshUsers = networkEdge.sshUsers().list();
 PaginatedList<ACLTemplate> templates = networkEdge.aclTemplates().list();
 

Version:

$Id: $Id

Author:

ianjones

See Also:

• BasicEquinixCredentials
• Devices
• SSHUsers

Field Summary

Fields inherited from class api.equinix.javasdk.EquinixClient

equinixClient

Constructor Summary

Constructors

Constructor	Description
NetworkEdge(EquinixCredentials equinixCredentials)	Creates a new Network Edge client using the provided credentials.
NetworkEdge(EquinixCredentials equinixCredentials, boolean isSandBoxed)	Creates a new Network Edge client with optional sandbox mode.

Method Summary

Modifier and Type	Method	Description
ACLTemplates	aclTemplates()	Returns the client for managing Access Control List (ACL) templates.
Backups	backups()	Returns the client for managing device configuration backups.
BGPPeerings	bgpPeerings()	Returns the client for managing BGP peering sessions on virtual devices.
DeviceLinks	deviceLinks()	Returns the client for managing device links between virtual network devices.
Devices	devices()	Returns the client for managing virtual network devices and device types.
PublicKeys	publicKeys()	Returns the client for managing SSH public keys.
Setup	setup()	Returns the client for Network Edge setup and provisioning operations.
SSHUsers	sshUsers()	Returns the client for managing SSH user accounts on virtual devices.
VPNs	vpns()	Returns the client for managing VPN connections on virtual devices.

Methods inherited from class api.equinix.javasdk.EquinixClient

authenticate, close, core

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NetworkEdge

public NetworkEdge(EquinixCredentials equinixCredentials)

Creates a new Network Edge client using the provided credentials. Authentication occurs automatically on the first API call.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

NetworkEdge

public NetworkEdge(EquinixCredentials equinixCredentials,
 boolean isSandBoxed)

Creates a new Network Edge client with optional sandbox mode.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Method Details

setup

public Setup setup()

Returns the client for Network Edge setup and provisioning operations. Provides access to account settings, metro availability, DNS configuration, license agreements, and pricing for virtual network devices.

Returns:

the Setup client for managing setup-related resources

devices

public Devices devices()

Returns the client for managing virtual network devices and device types. Devices are virtual appliances (routers, firewalls, SD-WAN) running at Equinix data centers. Supports creation via fluent builders, lifecycle management, and querying available device types.

Returns:

the Devices client for CRUD operations on virtual devices

publicKeys

public PublicKeys publicKeys()

Returns the client for managing SSH public keys. Public keys are uploaded and associated with virtual devices for secure SSH access without password-based authentication.

Returns:

the PublicKeys client for managing SSH public keys

deviceLinks

public DeviceLinks deviceLinks()

Returns the client for managing device links between virtual network devices. Device links create logical connections between devices, enabling multi-device topologies and high-availability configurations.

Returns:

the DeviceLinks client for creating and managing device links

sshUsers

public SSHUsers sshUsers()

Returns the client for managing SSH user accounts on virtual devices. SSH users define the credentials used to access virtual devices for configuration and management via SSH.

Returns:

the SSHUsers client for managing SSH user accounts

aclTemplates

public ACLTemplates aclTemplates()

Returns the client for managing Access Control List (ACL) templates. ACL templates define network access rules that can be applied to virtual devices to control inbound and outbound traffic.

Returns:

the ACLTemplates client for CRUD operations on ACL templates

vpns

public VPNs vpns()

Returns the client for managing VPN connections on virtual devices. VPNs establish secure, encrypted tunnels between virtual devices and remote network endpoints.

Returns:

the VPNs client for creating and managing VPN connections

bgpPeerings

public BGPPeerings bgpPeerings()

Returns the client for managing BGP peering sessions on virtual devices. BGP peerings enable dynamic route exchange between virtual devices and neighboring routers for network reachability.

Returns:

the BGPPeerings client for configuring BGP peering sessions

backups

public Backups backups()

Returns the client for managing device configuration backups. Backups capture the running configuration of virtual devices, enabling point-in-time recovery and configuration rollback.

Returns:

the Backups client for managing device backups