How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Perimeter 81 Networks API

This API allows you to manage and configure standard networks using the old API and keep you BC.

Perimeter 81 Networks API is one of 17 APIs that Perimeter 81 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Networks. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 32 operations across 19 paths, and defines 68 schemas. It is described by OpenAPI 3.0.0, at version 2.3.0.

Requests are made against 5 base URLs: https://virtserver.swaggerhub.com/perimeter81/public-api-yaml/1.0.0, https://api.perimeter81.com/api/rest, https://api.eu.sase.checkpoint.com/api/rest, https://api.au.sase.checkpoint.com/api/rest, https://api.in.sase.checkpoint.com/api/rest.

32 operations 19 paths 68 schemas 7 DELETE13 GET6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.3.0
Base URL
https://api.perimeter81.com/api/rest
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Perimeter 81 Networks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

Paths & Operations 32

Across 19 paths, the API surfaces 32 operations — 7 DELETE, 13 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Networks 32

This API allows you to manage and configure standard networks using the old API and keep you BC.

GET
/v2.3/networks
Get all Networks
getNetworks → 200401403
POST
/v2.3/networks
Create network
NetworksControllerV2_networkCreate body → 202400401402403
DELETE
/v2.3/networks/{networkId}
Delete network
NetworksControllerV2_networkDelete 1 param → 202401403404
GET
/v2.3/networks/{networkId}
Get network by Id
NetworksControllerV2_networkFind 1 param → 200401403404
PUT
/v2.3/networks/{networkId}
Update network
NetworksControllerV2_networkUpdate 1 param body → 200400401403404
GET
/v2.3/networks/{networkId}/health
Get network health status
NetworksControllerV2_getNetworkHealth 1 param → 200401403404
POST
/v2.3/networks/{networkId}/instances
Add gateway
NetworksControllerV2_addNetworkInstance 1 param body → 202400401402403404
DELETE
/v2.3/networks/{networkId}/instances
Remove Gateways from Network
NetworksControllerV2_deleteNetworkInstance 1 param body → 202400401403404
GET
/v2.3/networks/{networkId}/instances/{gatewayId}
Get Instance of a GW by ID
getInstance 2 params → 200401403404
GET
/v2.3/networks/status/{statusId}
Get status of asynchronous operations.
NetworksControllerV2_status 1 param → 200401403404
GET
/v2.3/networks/harmony-sase-regions
List of available regions
NetworksControllerV2_getRegions → 200401403
PUT
/v2.3/networks/{networkId}/regions
Add regions to a network
NetworksControllerV2_addNetworkRegion 1 param body → 202400401403404409
DELETE
/v2.3/networks/{networkId}/regions
Remove regions from network
NetworksControllerV2_deleteNetworkRegion 1 param body → 202401403404
GET
/v2.3/networks/{networkId}/regions/{regionId}
Get region by ID
getRegion 2 params → 200401403404
POST
/v2.3/networks/{networkId}/tunnels/wireguard
Create a new Wireguard tunnel
createWireguardTunnel 1 param body → 202401402403404422
GET
/v2.3/networks/{networkId}/tunnels/wireguard/{tunnelId}
Get a Wireguard tunnel
getWireguardTunnel 2 params → 200401403404
PUT
/v2.3/networks/{networkId}/tunnels/wireguard/{tunnelId}
Update a Wireguard tunnel
updateWireguardTunnel 2 params body → 202401403404422
DELETE
/v2.3/networks/{networkId}/tunnels/wireguard/{tunnelId}
Delete Wireguard tunnel
deleteWireguardTunnel 2 params → 202401403404422
POST
/v2.3/networks/{networkId}/tunnels/openvpn
Create a new OpenVPN tunnel
createOpenVPNTunnel 1 param body → 202401402403404422
GET
/v2.3/networks/{networkId}/tunnels/openvpn/{tunnelId}
Get one openVPN tunnel
getOpenVPNTunnel 2 params → 200401403404
PUT
/v2.3/networks/{networkId}/tunnels/openvpn/{tunnelId}
Update openVPN Tunnel
updateOpenVPNTunnel 2 params → 202401403404
DELETE
/v2.3/networks/{networkId}/tunnels/openvpn/{tunnelId}
Delete OpenVPN tunnel
deleteOpenVPNTunnel 2 params → 202401403404422
POST
/v2.3/networks/{networkId}/tunnels/ipsec/single
Create a new IPSec Single tunnel
createIPSecSingleTunnel 1 param body → 202401402403404422
GET
/v2.3/networks/{networkId}/tunnels/ipsec/single/{tunnelId}
Get one IPSec Single tunnel
getIPSecSingleTunnel 2 params → 200401403404
PUT
/v2.3/networks/{networkId}/tunnels/ipsec/single/{tunnelId}
Update IPSec Single Tunnel
updateIPSecSingleTunnel 2 params body → 202401403404
DELETE
/v2.3/networks/{networkId}/tunnels/ipsec/single/{tunnelId}
Delete IPSec Single tunnel
deleteIPSecSingleTunnel 2 params → 202401403404422
POST
/v2.3/networks/{networkId}/tunnels/ipsec/redundant
Create a new IPSec Redundant tunnel
createIPSecRedundantTunnel 1 param body → 202401402403404422
GET
/v2.3/networks/{networkId}/tunnels/ipsec/redundant/{haTunnelId}
Get one IPSec Redundant tunnel
getIPSecRedundantTunnel 2 params → 200401403404
PUT
/v2.3/networks/{networkId}/tunnels/ipsec/redundant/{haTunnelId}
Update a new IPSec Redundant tunnel
updateIPSecRedundantTunnel 2 params body → 202401403404
DELETE
/v2.3/networks/{networkId}/tunnels/ipsec/redundant/{haTunnelId}
Delete IPSec Redundant tunnel
deleteIPSecRedundantTunnel 2 params → 202401403404422
GET
/v2.3/networks/{networkId}/route-table
Get route table
getRouteTable 1 param → 200401403404
GET
/v2.3/status
Get system status
getStatus → 200401403

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Region (9 properties), IPSecAdvancedSettings (7 properties), IPSecRedundantTunnelDetails (6 properties), CreateIPSecRedundantPayload (6 properties). Each schema is shown below with its type and property counts.

ASN
integer
Autonomous System Number (ASN) for BGP routing. It will be automatically assigned an ASN once creating the first dynamic tunnel in this network. The network AS…
AsyncOperationResult
object
3 properties
NetworkHaTunnelID
IPSecSingleTunnel
object
1 property
NetworkTunnel
RemoveRegionInstance
object
1 property 1 required
TunnelName
string
The name of the tunnel
RemoveRegionDTO
object
1 property 1 required
RemoveInstancePayload
object
1 property
StandardHealthCheckMeta
object
3 properties 2 required
NetworkInstance
CreateIPSecRedundantPayload
object
6 properties 6 required
StandardHealthCheckType
string
Type of health check component for standard networks
IPSecRedundantTunnel
WireguardTunnel
UpdateIPSecRedundantPayload
object
4 properties 3 required
IPSecRedundantTunnelPayload
IPSecPhaseConfig
IPSecRedundantTunnelUpdatePayload
IPSecSharedSettings
object
5 properties 2 required
BasicNetwork
CreateIPSecSinglePayload
13 required
RegionsList
array
description of regions dto object.
Region
object
9 properties
UpdateNetworkDto
object
1 property 1 required
StandardHealthResponse
object
1 property 1 required
NetworkTunnelWireguard
NetworkTunnelIpsecRedundant
AsyncOperationResponse
object
2 properties
ScaleUnitsCount
integer
Number of scale units for the region. Scale units determine the capacity and performance level of the enhanced region. Higher values provide greater throughput…
IPSecAdvancedSettings
object
7 properties 7 required
Network
IP
string
CreateWireguardTunnelPayload
IPSecAlgorithms
object
2 properties
BaseNetworkDto
object
2 properties
OpenVPNAsyncOperationResponse
object
3 properties
PeakBandwidth
integer
Expected peak throughput of the tunnel communication in Mbps. Typical connection will be of 1000Mbps.
RemoteASN
integer
Lifetime
string
AsyncOperationStatus
object
2 properties
IPSecPhaseCommon
object
1 property 3 required
CreatePassphrase
string
StandardHealthCheck
object
3 properties 3 required
BaseDates
object
2 properties 1 required
NetworkRegion
HealthStatus
string
Health status of the component
remoteID
NetworkTunnelBase
OpenVPNTunnel
object
4 properties
CreateRegionInNetworkPayload
object
3 properties 2 required
WireGuradDetails
object
2 properties 2 required
NetworkTunnelIpsecSingle
BaseTunnelValues
object
3 properties 3 required
NetworkTunnelOpenvpn
IPSecRedundantTunnels
RemoveRegionPayload
object
2 properties
IPSecRedundantTunnelDetails
object
6 properties 6 required
DeployNetworkPayload
object
2 properties 2 required
NetworkIpsecBase
IPSecSharedSettingsCreate
1 required
Passphrase
string
DPDTime
string
Error
object
2 properties
CreateNetworkPayload
object
3 properties 1 required
IPSecSingleDetails
UpdatedNetwork
CreateInstancesInNetworkPayload
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

perimeter-81-networks-api-openapi.yml Raw ↑

Other APIs Perimeter 81 publishes across the network.

Perimeter 81 Application API
Perimeter 81 Enhanced Networks API
Perimeter 81 Enhanced Regions API
Perimeter 81 Enhanced Route Tables API
Perimeter 81 Enhanced Tunnels API
Perimeter 81 Firewall Policy API
Perimeter 81 Gateways API
Perimeter 81 IPSec-Redundant API
Perimeter 81 IPSec-Single API
Perimeter 81 Objects Addresses API
Perimeter 81 Objects Services API
Perimeter 81 OpenVPN API
Where this information came from

This is an independent, third-party profile of Perimeter 81 Networks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.